changi 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d7fbfb1689d7effa8bed7d6ca6ca66073b6f31f
+  data.tar.gz: c436fe107d78b2479e66f578e0a92ba783eb3344
+SHA512:
+  metadata.gz: c4e10adc77fde7170e214922b6a9845f17a0af8d4b039bb53944076e424287e126c4236ca66480da5ebf0b46f9f5534a4b1135f86929808c36cbd71ec886da23
+  data.tar.gz: 0e8c75ba30d82a81ff03acfd492db5f8f3cd4abb75628ce3f85a15450722b748f0ab7c9d58201d09ed26d75b5fe626b4889ab49bcd859e9e8e4a17c6b6274ebf

data/lib/changi/changelog.rb

@@ -0,0 +1,29 @@
+module Changi
+  class Changelog
+    def initialize config
+      @config = config
+    end
+
+    def new_entry
+      entry_set.new_entry
+    end
+
+    def render demo: false
+      release  = demo ? Release.demo : Release.build
+      renderer = Renderer.new @config, entry_set, release
+      renderer.render
+    end
+
+    def update
+      updater = @config.updater.new
+      updater.update @config.changelog_path, render
+      entry_set.destroy_all
+    end
+
+    private
+
+    def entry_set
+      @entry_set ||= EntrySet.new @config
+    end
+  end
+end

data/lib/changi/configuration.rb

@@ -0,0 +1,34 @@
+module Changi
+  class Configuration
+    attr_accessor :changelog_path
+    attr_accessor :entries_path
+    attr_accessor :default_categories
+    attr_accessor :updater
+    attr_accessor :changelog_template
+
+    def self.default
+      new.tap do |config|
+        config.changelog_path     = File.join Dir.pwd, 'changelog.md'
+        config.entries_path       = File.join Dir.pwd, 'changelog'
+        config.default_categories = []
+        config.updater            = Updater::PrependUpdater
+        config.changelog_template = <<-eod
+# <%= release.version %>, <%= Time.now.strftime('%Y-%m-%d') %><%= release.notes and ", \#{release.notes}" %>
+<% entry_set.entries_by_category.each do |category, entries| %>
+## <%= category %>
+
+<%=
+  entries.map do |e|
+    if e.text.is_a?(Array)
+      e.text.map.with_index { |l, i| i == 0 ? "* \#{l}" : "  \#{l}" }.join("\n")
+    else
+      "* \#{e.text.gsub("\n", ' ')}"
+    end
+  end.join("\n")
+%>
+<% end %>
+eod
+      end
+    end
+  end
+end

data/lib/changi/entry.rb

@@ -0,0 +1,48 @@
+require 'yaml'
+
+module Changi
+  class Entry
+    include FlexibleAttributes
+
+    class << self
+      def build entry_set, yaml_path
+        new(entry_set, yaml_path).tap &:read_in_attributes
+      end
+
+      def load entry_set, yaml_path
+        new(entry_set, yaml_path).tap &:read_in_yaml
+      end
+    end
+
+    define_attribute :category, reader: Reader::CategoryReader
+    define_attribute :text, reader: Reader::MultilineReader, opts: { required: true }
+
+    attr_reader :entry_set
+
+    def initialize entry_set, path
+      @entry_set = entry_set
+      @path      = path
+    end
+
+    def read_in_yaml
+      data = YAML.load_file @path
+      self.class.attribute_names.each { |name| send "#{name}=".to_sym, data[name] }
+    end
+
+    def save
+      File.open(@path, 'w') { |fd| fd.puts to_yaml }
+    end
+
+    def destroy
+      unless system "git rm '#{@path}' >/dev/null 2>&1"
+        FileUtils.rm_f @path
+      end
+    end
+
+    private
+
+    def to_yaml
+      self.class.attribute_names.map { |name| [name, send(name.to_sym)] }.to_h.to_yaml
+    end
+  end
+end

data/lib/changi/entry_set.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+
+module Changi
+  class EntrySet
+    attr_reader :config
+
+    def initialize config
+      @config = config
+      FileUtils.mkdir_p @config.entries_path
+    end
+
+    def new_entry
+      entries << Entry.build(self, make_entry_path).tap(&:save)
+    end
+
+    def entries
+      @entries ||= yamls.map { |yml| Entry.load self, yml }
+    end
+
+    def entries_by_category
+      entries.group_by &:category
+    end
+
+    def previous_categories
+      entries.map &:category
+    end
+
+    def destroy_all
+      entries.each &:destroy
+    end
+
+    private
+
+    def yamls
+      Dir["#{@config.entries_path}/*yml"]
+    end
+
+    def make_entry_path
+      File.join @config.entries_path, make_entry_name
+    end
+
+    def make_entry_name
+      if git_branch = `git rev-parse --abbrev-ref HEAD 2>/dev/null`.strip
+        "#{Time.now.strftime('%y%m%d%H%M%S')}_from_#{git_branch}.yml"
+      else
+        "#{Time.now.strftime('%y%m%d%H%M%S')}.yml"
+      end
+    end
+  end
+end

data/lib/changi/flexible_attributes.rb

@@ -0,0 +1,33 @@
+module Changi
+  module FlexibleAttributes
+    module ClassMethods
+      def attributes
+        @attributes ||= []
+      end
+
+      def attribute_names
+        attributes.map { |x| x[:name] }
+      end
+
+      def define_attribute name, reader: Reader::StringReader, opts: {}, &block
+        attr_accessor name.to_sym
+
+        attributes << {
+          name: name,
+          reader: (block_given? ? block : ->(*args) { reader.new.read *args }),
+          opts:   opts
+        }
+      end
+    end
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    def read_in_attributes
+      self.class.attributes.each do |data|
+        send "#{data[:name]}=".to_sym, data[:reader].call(data, self)
+      end
+    end
+  end
+end

data/lib/changi/reader/category_reader.rb

@@ -0,0 +1,24 @@
+module Changi
+  module Reader
+    class CategoryReader < StringReader
+      def read attribute, owner
+        fail 'CategoryReader can only be used for Entry attributes.' unless owner.is_a? Entry
+
+        cli.say "#{attribute[:name].capitalize}:\n"
+        cli.choose do |menu|
+          menu.choices *categories(owner.entry_set)
+          menu.choice 'Other (create new)' do
+            cli.ask "Please insert #{attribute[:name]}:"
+          end
+          menu.choice('Abort') { exit }
+        end
+      end
+
+      private
+
+      def categories entry_set
+        (entry_set.previous_categories + entry_set.config.default_categories).uniq
+      end
+    end
+  end
+end

data/lib/changi/reader/multiline_reader.rb

@@ -0,0 +1,63 @@
+require 'tempfile'
+
+module Changi
+  module Reader
+    class MultilineReader
+      def read attribute, owner
+        tmpfile = Tempfile.new 'changi'
+
+        intro tmpfile, attribute
+
+        unless system "#{editor} '#{tmpfile.path.strip}'"
+          abort 'editor returned with non-zero exit status, abort'
+        end
+
+        read_and_strip(tmpfile).tap do |data|
+          if attribute[:opts][:required] && data.empty?
+            abort "required #{attribute[:name]} attribute empty, abort"
+          end
+        end
+      ensure
+        tmpfile.close
+        tmpfile.unlink
+      end
+
+      private
+
+      def intro tmpfile, attribute
+        tmpfile.puts
+        tmpfile.puts
+        tmpfile.puts "# Please enter #{attribute[:name]} above."
+        tmpfile.puts "# Lines starting with # will be ignored."
+        tmpfile.puts "# Empty tmpfile will abort the process." if attribute[:opts][:required]
+        tmpfile.sync
+        tmpfile.close
+      end
+
+      def read_and_strip tmpfile
+        tmpfile.open
+        tmpfile.read.strip.split("\n").reject { |x| x =~ /^\s*#/ }
+               .drop_while(&:empty?).reverse.drop_while(&:empty?).reverse
+      end
+
+      def editor
+        editor_tests.lazy.map(&:call).find { |e| !(e.nil? || e.empty?) }.tap do |e|
+          fail 'could not detect editor' unless e
+        end
+      end
+
+      def editor_tests
+        [
+          -> { ENV['EDITOR'] },
+          -> { `git config core.editor`.strip },
+          -> { editor_exists?('nano') && 'nano' },
+          -> { editor_exists?('vim') && 'vim' }
+        ]
+      end
+
+      def editor_exists? app
+        system "command -v #{app} >/dev/null 2>&1"
+      end
+    end
+  end
+end

data/lib/changi/reader/string_reader.rb

@@ -0,0 +1,21 @@
+require 'highline'
+
+module Changi
+  module Reader
+    class StringReader
+      def read attribute, owner
+        cli.ask("#{attribute[:name]}: ").tap do |x|
+          if attribute[:opts][:required] && [nil, ''].include?(x)
+            abort "required #{attribute[:name]} attribute empty, abort"
+          end
+        end
+      end
+
+      protected
+
+      def cli
+        @cli ||= HighLine.new
+      end
+    end
+  end
+end

data/lib/changi/release.rb

@@ -0,0 +1,20 @@
+module Changi
+  class Release
+    include FlexibleAttributes
+
+    class << self
+      def build
+        new.tap &:read_in_attributes
+      end
+
+      def demo
+        new.tap do |inst|
+          attribute_names.each { |name| inst.send "#{name}=".to_sym, "<#{name}>" }
+        end
+      end
+    end
+
+    define_attribute :version
+    define_attribute :notes
+  end
+end

data/lib/changi/renderer.rb

@@ -0,0 +1,18 @@
+require 'erb'
+
+module Changi
+  class Renderer
+    attr_reader :entry_set
+    attr_reader :release
+
+    def initialize config, entry_set, release
+      @config  = config
+      @entry_set = entry_set
+      @release   = release
+    end
+
+    def render
+      ERB.new(@config.changelog_template).result binding
+    end
+  end
+end

data/lib/changi/tasks.rb

@@ -0,0 +1,20 @@
+require 'changi'
+
+namespace :changi do
+  desc 'Create a new changelog entry'
+  task :new do
+    Changi.changelog.new_entry
+  end
+
+  desc 'Show changelog for next release'
+  task :diff do
+    puts Changi.changelog.render demo: true
+  end
+
+  desc 'Update project changelog for release'
+  task :update do
+    Changi.changelog.update
+    puts 'Changelog updated, and changelog directory cleared.'
+    puts 'Check if there were manual changes to changelog.md and merge them before committing.'
+  end
+end

data/lib/changi/updater/prepend_updater.rb

@@ -0,0 +1,15 @@
+module Changi
+  module Updater
+    class PrependUpdater
+      def update changelog_path, release_data
+        previous = File.read changelog_path if File.exists? changelog_path
+
+        File.open changelog_path, 'w' do |fd|
+          fd.puts release_data
+          fd.puts
+          fd.puts previous if previous
+        end
+      end
+    end
+  end
+end

data/lib/changi.rb

@@ -0,0 +1,27 @@
+require 'changi/reader/string_reader'
+require 'changi/reader/multiline_reader'
+require 'changi/reader/category_reader'
+require 'changi/updater/prepend_updater'
+require 'changi/flexible_attributes'
+require 'changi/changelog'
+require 'changi/configuration'
+require 'changi/entry'
+require 'changi/entry_set'
+require 'changi/release'
+require 'changi/renderer'
+
+module Changi
+  class << self
+    def configuration
+      @configuration ||= Configuration.default
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def changelog
+      @changelog ||= Changelog.new configuration
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: changi
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Mobisol GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Manages a set of changelog entries for you and combines them to a changelog
+  file when you release.
+email: dev@plugintheworld.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/changi.rb
+- lib/changi/changelog.rb
+- lib/changi/configuration.rb
+- lib/changi/entry.rb
+- lib/changi/entry_set.rb
+- lib/changi/flexible_attributes.rb
+- lib/changi/reader/category_reader.rb
+- lib/changi/reader/multiline_reader.rb
+- lib/changi/reader/string_reader.rb
+- lib/changi/release.rb
+- lib/changi/renderer.rb
+- lib/changi/tasks.rb
+- lib/changi/updater/prepend_updater.rb
+homepage: https://github.org/plugintheworld/changi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Tiny library of changelog management rake tasks.
+test_files: []
+has_rdoc: