Skip to content

Commit

Permalink
Merge pull request #285 from ardumont/0.7.4
Browse files Browse the repository at this point in the history
0.7.4
  • Loading branch information
ardumont committed Aug 24, 2015
2 parents dfbccfc + f95d19d commit 522ec04
Show file tree
Hide file tree
Showing 45 changed files with 7,977 additions and 1,765 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -11,3 +11,4 @@
/*org-trello-testing-buffer*
/_site/
/dist/
flycheck_*.el
3 changes: 3 additions & 0 deletions Cask
Expand Up @@ -19,10 +19,13 @@
"org-trello-date.el"
"org-trello-buffer.el"
"org-trello-input.el"
"org-trello-deferred.el"
"org-trello-controller.el"
"README.md")

(development
(depends-on "dash-functional")
(depends-on "dash")
(depends-on "ert-runner")
(depends-on "undercover")
(depends-on "ert")
Expand Down
37 changes: 20 additions & 17 deletions Makefile
@@ -1,48 +1,45 @@
VERSION=$$(grep "^;; Version: " org-trello.el | cut -f3 -d' ')
PACKAGE_FOLDER=org-trello-$(VERSION)
ARCHIVE=$(PACKAGE_FOLDER).tar
EMACS=emacs
LOG_TEST_FILE=./run-org-trello-tests.log
PACKAGE = org-trello
VERSION = $$(grep "^;; Version: " $(PACKAGE).el | cut -f3 -d' ')
ARCHIVE = $(PACKAGE)-$(VERSION).tar
EMACS ?= emacs
CASK ?= cask

.PHONY: clean

pr:
hub pull-request -b org-trello:master

deps:
cask
${CASK}

build:
cask build
${CASK} build

clean-dist:
rm -rf dist/

clean: clean-dist
rm -rf *.tar
cask clean-elc
${CASK} clean-elc

install:
cask install
${CASK} install

test: clean
cask exec ert-runner

test-log:
less $(LOG_TEST_FILE)
${CASK} exec ert-runner

pkg-file:
cask pkg-file
${CASK} pkg-file

pkg-el: pkg-file
cask package
${CASK} package

package: clean pkg-el
cp dist/$(ARCHIVE) .
make clean-dist

info:
cask info
${CASK} info

install-package-from-melpa:
./install-package-from.sh melpa
Expand All @@ -56,7 +53,10 @@ cleanup-data:
~/.emacs.d/elnode/public_html/org-trello/*.lock

release:
./release.sh $(VERSION)
./release.sh $(VERSION) $(PACKAGE)

version:
@echo "application $(PACKAGE): $(VERSION)\npackage: $(ARCHIVE)"

install-cask:
curl -fsSkL https://raw.github.com/cask/cask/master/go | python
Expand All @@ -66,3 +66,6 @@ emacs-install-clean: package

respect-convention:
./contrib/respect-elisp-conventions.sh

tests:
./run-tests.sh 24.3-bin 24.4-bin 24.5-bin
50 changes: 33 additions & 17 deletions README-dev.md
Expand Up @@ -30,21 +30,24 @@ This is described in the [Namespaces](#namespaces) section.

As there exists no namespace in emacs-lisp, I use:
- convention in function names to determine the nature private/public
- splitted file that represents namespaces.
- splitted files that represents namespaces.

### Rules

The conventions enforced in org-trello:

- functions are prefixed with `orgtrello-<NAMESPACE-FILENAME>-<FUNCTION-NAME>`
- `<NAMESPACE-FILENAME>` is the filename without its path nor its extension. For example, `src/buffer.el` renders `buffer`
- `<FUNCTION-NAME>` is an alphanumeric symbol with `-` as separator. For example, `orgtrello-api-add-board` is a public function which does create a request to add a board.
- private functions are prefixed with `--`. For example, `orgtrello-api--deal-with-optional-values` which is a private utility function to help in creating api request.
- predicate functions are suffixed by `-p`. For example, `orgtrello-data-entity-card-p` which checks if the parameter entity is a card or not.

For example:
- in `org-trello-buffer.el`, all pure public functions are named `orgtrello-buffer-some-fn-name`
- in `org-trello-input.el`, all pure private functions are named `orgtrello-input--some-private-fn`
- `<NAMESPACE-FILENAME>` is the filename without its path nor its extension.
For example, `src/buffer.el` renders `buffer`
- `<FUNCTION-NAME>` is an alphanumeric symbol with `-` as separator.
For example, `orgtrello-api-add-board` is a public function which does create a
request to add a board.
- private functions are prefixed with `--`. For example,
`orgtrello-api--deal-with-optional-values` which is a private utility function
to help in creating api request.
- predicate functions are suffixed by `-p`. For example,
`orgtrello-data-entity-card-p` which checks if the parameter entity is a card
or not.

*Note* I adapted the code to abide by [emacs-lisp's conventions](https://www.gnu.org/software/emacs/manual/html_node/elisp/Coding-Conventions.html).

Expand All @@ -63,7 +66,9 @@ The namespaces are in loading order:
Namespaces file | Description of the namespace
-----------------------------|------------------------------------------------------------------------
org-trello-log.el | Provide log facilities
org-trello-setup.el | Main variable definition that permits internal org-trello functions customization
org-trello-setup.el | Main variable definition that permits internal
| org-trello functions customization
org-trello-date.el | org-trello's date manipulation
org-trello-hash.el | Hash-map manipulation utilities
org-trello-action.el | Higher-order functions helper
org-trello-data.el | Internal org-trello data manipulation
Expand All @@ -72,11 +77,18 @@ org-trello-cbx.el | Checkbox manipulation utilities
org-trello-api.el | Trello API abstraction DSL
org-trello-query.el | HTTP query utilities
org-trello-backend.el | Deals with trello requests
org-trello-proxy.el | Proxy utilities - Namespace in charge of dealing with the orchestration of trello requests
org-trello-proxy.el | Proxy utilities - Namespace in charge of dealing
| with the orchestration of trello requests
org-trello-buffer.el | Buffer manipulation functions
org-trello-input.el | Text input functions
org-trello-controller.el | Controller used by org-trello.el
org-trello.el | Main information about org-trello (version, licence, deps, etc...) + org-trello minor mode definition which defines interactive commands and the mode
org-trello-deferred.el | Deferred computation in org-trello
org-trello.el | Main information about org-trello (version,
| licence, deps, etc...) + org-trello minor mode
| definition which defines interactive commands
| and the mode
-----------------------------|-------------------------------------------------------------------------
utilities.el | test utilities functions

## Loading

Expand Down Expand Up @@ -109,7 +121,8 @@ make test

## Install

To test that the package, once created, can be installed (using the repository to fetch the dependencies).
To test that the package, once created, can be installed (using the repository
to fetch the dependencies).

```sh
make install-file-with-deps-from-melpa
Expand Down Expand Up @@ -142,7 +155,7 @@ The release process is done through 2 steps:

*Note* You need `hub` installed for this target to work.

- Then trigger the release through the call to the release target from the Makefile
- Then trigger release through the call to the release target from the Makefile

```sh
make release
Expand All @@ -152,11 +165,14 @@ This will:
- fetch the latest modifications on your repository
- checkout the master branch
- fast-forward to the latest master commit
- tag the latest commit from master using the $VERSION you submit to the script (defaulting to the version from the org-trello.el header)
- tag the latest commit from master using the $VERSION you submit to the script
(defaulting to the version from the org-trello.el header)
- push the tag to the upstream branch repository
- trigger the package target from the Makefile (thus building a new package to the latest version)
- trigger the package target from the Makefile (thus building a new package to
the latest version)
- Then manual delivery of the tar to the github release page

Note:
- this is an orchestration of the [release.sh](./release.sh) script
- the packaging for MELPA is automatically done from `org-trello/org-trello` repository
- the packaging for MELPA is automatically done from `org-trello/org-trello`
repository
2 changes: 1 addition & 1 deletion README.md
@@ -1,4 +1,4 @@
org-trello [![Build Status](https://travis-ci.org/org-trello/org-trello.png?branch=master)](https://travis-ci.org/org-trello/org-trello) [![MELPA Stable](http://stable.melpa.org/packages/org-trello-badge.svg)](http://stable.melpa.org/#/org-trello) [![MELPA](http://melpa.org/packages/org-trello-badge.svg)](http://melpa.org/#/org-trello)
org-trello [![Build Status](https://travis-ci.org/org-trello/org-trello.png?branch=master)](https://travis-ci.org/org-trello/org-trello) [![Coverage Status](https://coveralls.io/repos/org-trello/org-trello/badge.svg?branch=master&service=github)](https://coveralls.io/github/org-trello/org-trello?branch=master) [![MELPA Stable](http://stable.melpa.org/packages/org-trello-badge.svg)](http://stable.melpa.org/#/org-trello) [![MELPA](http://melpa.org/packages/org-trello-badge.svg)](http://melpa.org/#/org-trello)
==========

The [full documentation](http://org-trello.github.io/) is maintained!
Expand Down
19 changes: 19 additions & 0 deletions TODO.org
Expand Up @@ -15,6 +15,7 @@
- [ ] #059 - One command to sync them all
- [ ] #211 - Add a file to the org-trello list
- [ ] #130 - Use active region
- [ ] #279 - Improve parsing of org-trello elements

** Doc

Expand All @@ -32,6 +33,24 @@
- [ ] #248 - Installing from melpa (unstable) works, but then it errs on an undefined variable "error-messages"
- [ ] #263 - Colors broken in org trello

* DONE 0.7.4 [100%]
CLOSED: [2015-08-24 Mon 23:39]
- [X] Improve release script + fix typo
- [X] Update version
- [X] Coverage [10/10]
- [X] stats-coverage.org for statistics (+ travis-ci/coverage.io)
- [X] Fix bug on org-trello-log namespace + org-trello-log
- [X] org-trello-input
- [X] org-trello-query
- [X] org-trello-proxy
- [X] org-trello-buffer
- [X] org-trello-controller
- [X] org-trello-data
- [X] org-trello-hash
- [X] org-trello
- [X] #283 - Toggle assign me action
- [X] Release notes

* DONE 0.7.3 [100%]
CLOSED: [2015-08-14 Fri 22:37]
- [X] Update version
Expand Down

0 comments on commit 522ec04

Please sign in to comment.