amanuensis 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6d31e90bdbc3a3fd422124fc0429c1b0895dd8e
+  data.tar.gz: ca8759f8ae3ae360e3bfba91925c4935f684f2ba
+SHA512:
+  metadata.gz: 4d4043f7916c87e5718a69fbc1d020ce4ec4318bd863b166f1b0e0a52a86dfdb0281cd20c275dd974c9fe10fe7690ece1a1c2f6db0bb6824832f1a2d0fbcac7d
+  data.tar.gz: dd4a6deb5bf917d7e74f1e0aa4ab54834a4f9f44bc8a5b27b1a89e4269e28810a47a09b7b213411f476aaef824b5cf60beede42ebf793527918c8e6c0314ec53

data/.env.sample

@@ -0,0 +1,10 @@
+GITHUB_OAUTH_TOKEN=''
+GITHUB_REPO=''
+
+TRELLO_KEY=''
+TRELLO_TOKEN=''
+TRELLO_BOARD=''
+TRELLO_LIST=''
+
+PIVOTAL_TOKEN=''
+PIVOTAL_PROJECT=''

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amanuensis.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Anthony Laibe
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,248 @@
+# Amanuensis
+
+Amanuensis is a changelog generator which integrate with all the major code managers and trackers
+
+Your changelog will contains closed issues and pull requests based on the
+tracker you are using.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amanuensis'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amanuensis
+
+## Usage via command line
+
+Type ```amanuensis help generate``` for detailed usage.
+```
+Usage:
+  amanuensis generate
+
+Options:
+  p, [--push=one two three]
+                                    # Default: [:file]
+  t, [--tracker=TRACKER]
+                                    # Default: github
+  c, [--code-manager=CODE_MANAGER]
+                                    # Default: github
+  u, [--version=VERSION]
+                                    # Default: patch
+  v, [--verbose], [--no-verbose]
+  g, [--github=key:value]
+  c, [--trello=key:value]
+  i, [--pivotal=key:value]
+  m, [--mail=key:value]
+  f, [--file=key:value]
+
+Generate a changelog
+```
+
+Type ``` amanuensis generate [options]``` to generate the changelog
+
+
+## Usage via ruby
+
+Just call the method ```#generate```
+```ruby
+Amanuensis.generate
+```
+
+Before calling the generator you need to configure it:
+```ruby
+Amanuensis.push = [:github]
+  
+Amanuensis::Github.oauth_token = ENV.fetch('GITHUB_OAUTH_TOKEN')
+Amanuensis::Github.repo        = ENV.fetch('GITHUB_REPO')
+```
+
+Each integrations are configurable, just like ```Amanuensis```
+
+For ```Amanuensis```, it is possible to set:
+* push
+* code_manager
+* tracker
+* version
+* verbose
+
+```ruby
+Amanuensis.push = [:github, :file, :mail]
+Amanuensis.tracker = :github
+Amanuensis.code_manager = :github
+Amanuensis.version = :major
+Amanuensis.verbose = true
+```
+
+See below for all integrations available and their respective configuration
+
+## Version
+
+The allowed values for version are:
+* major
+* minor
+* patch
+
+And it works like that:
+```
+major.minor.patch
+```
+
+If there is not release the first version will be:
+```
+0.0.1
+```
+
+## Integrations
+
+### Code managers
+
+If you don't specify any code managers, ```github``` will be used by default
+
+#### Github
+
+If you use github as a code manager, a github release will be created at the end of the process
+The changelog will also contains all pull requests closed since the latest release
+
+Via command line:
+```
+amanuensis generator --github=oauth_token:my_token repo:alaibe/amanuensis
+```
+
+Via Ruby:
+```ruby
+Amanuensis::Github.oauth_token = ENV.fetch('GITHUB_OAUTH_TOKEN')
+Amanuensis::Github.repo        = ENV.fetch('GITHUB_REPO')
+```
+
+### Trackers
+
+If you don't specify any traker, ```github``` will be used by default
+
+#### Github
+
+If github is used, the changelog will contains the closed issues since the last release
+
+Via command line:
+```
+amanuensis generator --github=oauth_token:my_token repo:alaibe/amanuensis
+```
+
+Via Ruby:
+```ruby
+Amanuensis::Github.oauth_token = ENV.fetch('GITHUB_OAUTH_TOKEN')
+Amanuensis::Github.repo        = ENV.fetch('GITHUB_REPO')
+```
+
+#### Trello
+
+If trello is used, the changelog will contains the closed cards since the last release
+
+Via command line:
+```
+amanuensis generator --trello=key:my_key token:my_token board:amanuensis list:done
+```
+
+Via Ruby:
+```ruby
+Amanuensis::Trello.key   = ENV.fetch('TRELLO_KEY')
+Amanuensis::Trello.token = ENV.fetch('TRELLO_TOKEN')
+Amanuensis::Trello.board = ENV.fetch('TRELLO_BOARD')
+Amanuensis::Trello.list  = ENV.fetch('TRELLO_LIST')
+```
+
+#### Pivotal tracker
+
+If pivotal is used, the changelog will contains the accepted cards since the last release
+
+Via command line:
+```
+amanuensis generator --pivotal=token:my_token project:amanuensis
+```
+
+Via Ruby:
+```ruby
+Amanuensis::Pivotal.token   = ENV.fetch('PIVOTAL_TOKEN')
+Amanuensis::Pivotal.project = ENV.fetch('PIVOTAL_PROJECT')
+```
+
+### Push
+
+If you don't specify any push, ```file``` will be used by default
+
+Push is different from others integrations as you can chain them:
+```ruby
+Amanuensis.push = [:github, :mail, :file]
+```
+
+This configuration will publish the changelog to your github repository, send an
+e-mail with the changelog as a body and finaly produce a changelog file
+
+##### Github
+
+If you use github to push your changelog, it will be append to the file named Changelog.md by default
+
+Via command line:
+```
+amanuensis generator --github=oauth_token:my_token repo:alaibe/amanuensis
+file_name:new_changelog.md
+```
+
+Via Ruby:
+```ruby
+Amanuensis::Github.oauth_token = ENV.fetch('GITHUB_OAUTH_TOKEN')
+Amanuensis::Github.repo        = ENV.fetch('GITHUB_REPO')
+Amanuensis::Github.file_name   = ENV.fetch('GITHUB_FILE_NAME')
+```
+
+The option ```file_name``` is not required and is set to ```Changelog.md``` by default
+
+##### Mail
+
+We use the gem pony in order to send mail
+See the gem readme for all the options available: https://github.com/benprew/pony
+
+Via command line:
+```
+amanuensis generator --mail=to:anthony@amanuensis.com
+```
+
+Via Ruby:
+```ruby
+Amanuensis::Mail.pony = { to: 'anthony@amanuensis.com' }
+```
+
+##### File
+
+If you export push your changelog with the file option, it will create a file named ```Changelog.md``` by default
+
+```
+amanuensis generator --file=file_name:new_changelog.md
+```
+
+Via Ruby:
+```ruby
+Amanuensis::File.file_name   = 'new_changelog.md'
+```
+
+The option ```file_name``` is not required and is set to ```Changelog.md``` by default
+
+## Ask for new integration
+
+If you want new integration you can create an issue via github and add the label integration on it.
+
+## Contributing
+
+1. Fork it ( https://github.com/alaibe/amanuensis/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/amanuensis.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amanuensis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amanuensis"
+  spec.version       = Amanuensis::VERSION
+  spec.authors       = ["Anthony Laibe"]
+  spec.email         = ["anthony@laibe.cc"]
+  spec.summary       = %q{Amanuensis is a changelog generator}
+  spec.description   = %q{Amanuensis is a changelog generator which integrate with all the major code managers and trackers}
+  spec.homepage      = "http://alaibe.github.io/amanuensis"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "octokit", '~>3.8'
+  spec.add_dependency "pony", '~>1.11'
+  spec.add_dependency "activesupport", '~>4.2'
+  spec.add_dependency "interchange", '~>0.1'
+  spec.add_dependency "thor", '~>0.19'
+  spec.add_dependency "ruby-trello", '~>1.2'
+  spec.add_dependency "tracker_api", '~>0.2'
+
+  spec.add_development_dependency "bundler", '~>1.9'
+  spec.add_development_dependency "rake", '~>10.4'
+  spec.add_development_dependency "rspec", '~>3.2'
+  spec.add_development_dependency "vcr", '~>2.9'
+  spec.add_development_dependency "webmock", '~>1.21'
+  spec.add_development_dependency "dotenv", '~>2.0'
+  spec.add_development_dependency "pry-byebug", '~>3.1'
+end

data/bin/amanuensis

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/amanuensis'
+require 'pry'
+
+Amanuensis::CLI.start(ARGV)

data/lib/amanuensis.rb

@@ -0,0 +1,41 @@
+require 'interchange'
+require 'thor'
+require 'active_support/core_ext/object/blank'
+require 'active_support/configurable'
+
+require_relative 'amanuensis/version'
+require_relative 'amanuensis/validatable'
+require_relative 'amanuensis/cli'
+require_relative 'amanuensis/generator'
+require_relative 'amanuensis/builder'
+require_relative 'amanuensis/logger'
+require_relative 'amanuensis/push'
+require_relative 'amanuensis/code_manager'
+require_relative 'amanuensis/tracker'
+require_relative 'amanuensis/issue'
+require_relative 'amanuensis/pull'
+require_relative 'amanuensis/release'
+
+require_relative 'amanuensis/fake'
+require_relative 'amanuensis/github'
+require_relative 'amanuensis/trello'
+require_relative 'amanuensis/pivotal'
+require_relative 'amanuensis/mail'
+require_relative 'amanuensis/file'
+
+module Amanuensis
+  include ActiveSupport::Configurable
+  include Validatable
+
+  config_accessor(:push)         { [:file] }
+  config_accessor(:tracker)      { :github }
+  config_accessor(:code_manager) { :github }
+  config_accessor(:verbose)      { false }
+  config_accessor(:version)      { :patch }
+
+  validate_presence_of :push, :tracker, :code_manager, :version
+
+  def self.generate
+    Generator.new.run!
+  end
+end

data/lib/amanuensis/builder.rb

@@ -0,0 +1,52 @@
+module Amanuensis
+  class Builder < Struct.new(:version, :from)
+
+    def build
+      add_header
+      add_issues if issues.any?
+      add_pulls if pulls.any?
+
+      changelog
+    end
+
+    private
+
+    def changelog
+      @changelog ||= ''
+    end
+
+    def add_header
+      changelog << "## #{version}-#{Time.now.strftime('%d/%m/%Y %H:%M:%S')}\n"
+      changelog << "\n"
+    end
+
+    def add_issues
+      changelog << "**Issues closed:**\n"
+
+      issues.each do |issue|
+        changelog << "* [##{issue.number}](#{issue.html_url}) #{issue.title}\n"
+      end
+
+      changelog << "\n"
+    end
+
+    def add_pulls
+      changelog << "**Pull requests closed:**\n"
+
+      pulls.each do |pull|
+        changelog << "* [##{pull.number}](#{pull.html_url}) #{pull.title}\n"
+      end
+
+      changelog << "\n"
+    end
+
+    def issues
+      @issues ||= Tracker.issues(from)
+    end
+
+    def pulls
+      @pulls ||= CodeManager.pulls(from)
+    end
+
+  end
+end