release_notes 0.1.3

data/lib/release_notes/cli.rb

@@ -0,0 +1,135 @@
+require 'thor'
+require 'release_notes'
+require 'release_notes/version'
+require 'release_notes/versioning'
+require 'release_notes/cli/helpers'
+require 'release_notes/generators/release_note'
+
+module ReleaseNotes
+  class CLI < Thor
+    
+    package_name 'ReleaseNotes'
+    map '-v' => :version
+
+
+    desc 'new', 'create a new release note'
+    method_option :destination, :aliases => '-d', :default => ReleaseNotes.release_note_folder, :desc => 'relative location of release note folder'
+    method_option :force, :aliases => '-f',  :type => :boolean, :desc => 'overwrite files that already exist'
+    method_option :increment, :aliases => '-i', :default => 'patch', :banner => 'MODE', :desc => 'increment version by mode'
+    method_option :message, :aliases => '-m', :desc => 'interactive release note bullet input'
+    method_option :version, :aliases => '-V', :desc => 'use the given version number'
+
+    def new
+      if options[:version].nil?
+        last_version = ReleaseNotes::Versioning.current_version_number(options[:destination])
+        update_version = ReleaseNotes::Versioning::Semantic.increment(last_version, options[:increment])
+      else
+        update_version = options[:version]
+      end
+
+      message = ReleaseNotes::CLI::Helpers.setup_message_obj
+
+      if options[:message]
+        message = ReleaseNotes::CLI::Helpers.interactive_bullets(message)        
+      end
+
+      ReleaseNotes::Generators::ReleaseNote.start([options[:destination],
+                                             message,
+                                             update_version,
+                                             "--force=#{options[:force] || false}"])
+    end
+
+
+    desc 'update', "update #{ReleaseNotes.release_note_model} model"
+    method_option :destination, :aliases => '-d', :default => ReleaseNotes.release_note_folder, :desc => 'relative location of release note folder'
+    method_option :no_log, :aliases => '-n', :type => :boolean, :default => false, :desc => 'disable README.md log of release notes'
+    method_option :reset, :aliases => '-r', :type => :boolean, :default => false, :desc => 'delete all model entries and rebuilds them'
+    # method_option :version, :aliases => '-V', :desc => 'update only the given version number'
+
+    def update
+      # If reset option is passed delete all release notes in model
+      if options[:reset]
+        stamp = nil
+        release_log = ""
+
+        begin
+          File.delete("#{options[:destination]}/README.md")
+        rescue Errno::ENOENT
+          # Nothing to see here... move along.
+        end
+
+        ReleaseNotes.release_note_model.constantize.all.each do |rn|
+          rn.destroy
+        end
+      else
+        # Checks timestamp of last release note stored
+        begin
+          stamp = File.read("#{options[:destination]}/stamp")
+        rescue Errno::ENOENT
+          stamp = nil
+        end
+
+        # Reads contents of release note compilation file
+        begin
+          release_log = File.read("#{options[:destination]}/README.md")
+        rescue Errno::ENOENT
+          release_log = ""
+        end
+      end
+
+      # Collects relevant files and saves version and content to db
+      update_files = collect_update_files(options[:destination])
+      update_files.each do |file|
+        timestamp = file[0].to_i
+
+        if !stamp.nil? and timestamp <= stamp.to_i
+          next
+        end 
+
+        version = file[1..4].join('.')[0..-4]
+
+        file = file.join('_')
+        markdown = File.read("#{options[:destination]}/#{file}")
+        ReleaseNotes.release_note_model.constantize.create(version: version,
+                                                           markdown: markdown)
+
+        release_log.insert(0, "#{markdown}\n\n---\n\n") unless options[:no_log]
+      end
+
+      # Store the timestamp of the last release note
+      new_stamp = latest_update_file(options[:destination])
+      File.write("#{options[:destination]}/stamp", "#{new_stamp}", mode: 'w')
+
+      # Store release note compilation file
+      File.write("#{options[:destination]}/README.md", "#{release_log}", mode: 'w') unless options[:no_log]
+
+      say "#{ReleaseNotes.release_note_model} model successfully updated.", :green
+      say "ReleaseNotes log successfully updated (see #{options[:destination]}/README.md).", :green unless options[:no_log]
+    end
+
+
+    desc 'version', 'show version of release_notes'
+
+    def version
+      puts "ReleaseNotes #{ReleaseNotes::VERSION}"
+    end
+
+
+    protected
+      def collect_update_files(dirname)
+        update_lookup_at(dirname).collect do |file|
+          File.basename(file).split('_')
+        end
+      end
+
+      def latest_update_file(dirname)
+        update_lookup_at(dirname).collect do |file|
+          File.basename(file).split('_').first.to_i
+        end.max.to_i
+      end
+
+      def update_lookup_at(dirname)
+        Dir.glob("#{dirname}/[0-9]*_*.md")
+      end
+  end
+end

data/lib/release_notes/engine.rb

@@ -0,0 +1,5 @@
+module ReleaseNotes
+  class Engine < ::Rails::Engine
+    isolate_namespace ReleaseNotes
+  end
+end

data/lib/release_notes/generators/release_note.rb

@@ -0,0 +1,78 @@
+require 'thor/group'
+
+module ReleaseNotes
+  module Generators
+    class ReleaseNote < Thor::Group
+      include Thor::Actions
+
+      argument :destination, :type => :string
+      argument :message, :type => :hash
+      argument :release_version, :type => :string
+
+      class_option :force, :type => :boolean, :default => false
+
+      source_root File.expand_path('../../../generators/templates', __FILE__)
+      
+      def set_local_assigns
+        @app_name = ReleaseNotes.app_name
+        @update_template = 'update_blank.md'
+        @destination = File.expand_path(destination)
+        @release_version = release_version.gsub('.', '_')
+        @message = message
+
+        message.each do |k,v|
+          if v.length > 0
+            @update_template = 'update.md'
+            break
+          end
+        end
+      end
+
+      def create_update_file
+        empty_directory(@destination)
+      end
+
+      def check_version
+        destination = version_exists?(@destination, @release_version)
+
+        if destination
+          if options.force?
+            remove_file(destination)
+          else
+            raise Thor::Error, 
+<<-ERROR
+    Another update was found using the version number #{@release_version.gsub('_', '.')}. 
+    Use --force to remove the old update file and replace it.
+ERROR
+          end
+        end
+      end
+
+      def copy_release_note
+        update_number = next_update_number(destination)
+        @filename = "#{destination}/#{update_number}_#{@release_version}.md"
+        template(@update_template, @filename)
+      end
+
+      protected
+        def next_update_number(dirname)
+          next_update_number = current_update_number(dirname) + 1
+          [Time.now.utc.strftime('%Y%m%d%H%M%S'), '%.14d' % next_update_number].max
+        end
+
+        def current_update_number(dirname)
+          update_lookup_at(dirname).collect do |file|
+            File.basename(file).split('_').first.to_i
+          end.max.to_i
+        end
+
+        def update_lookup_at(dirname)
+          Dir.glob("#{dirname}/[0-9]*_*.md")
+        end
+
+        def version_exists?(dirname, file_name)
+          update_lookup_at(dirname).grep(/\d+_#{file_name}.md$/).first
+        end
+    end
+  end
+end

data/lib/release_notes/version.rb

@@ -0,0 +1,3 @@
+module ReleaseNotes
+  VERSION = "0.1.3"
+end

data/lib/release_notes/versioning/semantic.rb

@@ -0,0 +1,50 @@
+module ReleaseNotes
+  module Versioning
+    module Semantic
+      class << self
+        
+        def increment(version, type)
+          if version.nil?
+            ReleaseNotes.starting_version
+          else
+            parts = parse_version(version.gsub('.md', ''))
+
+            if type.downcase == 'major' or type == 'M'
+              parts = increment_major(parts)
+            elsif type.downcase == 'minor' or type == 'm'
+              parts = increment_minor(parts)
+            else
+              parts = increment_patch(parts)
+            end
+              
+            new_version = parts.join('.')
+            new_version
+          end
+        end
+      
+        protected
+          def parse_version(version)
+            version.split('-').first.split('.')
+          end
+
+          def increment_major(parts)
+            parts[0] = (parts[0].to_i + 1).to_s
+            parts[1] = '0'
+            parts[2] = '0'
+            parts
+          end
+
+          def increment_minor(parts)
+            parts[1] = (parts[1].to_i + 1).to_s
+            parts[2] = '0'
+            parts
+          end
+
+          def increment_patch(parts)
+            parts[2] = (parts[2].to_i + 1).to_s
+            parts
+          end
+      end
+    end
+  end
+end

data/lib/release_notes/versioning.rb

@@ -0,0 +1,26 @@
+require 'release_notes/versioning/semantic'
+
+module ReleaseNotes
+  module Versioning
+    class << self
+      def current_version_number(dirname)
+        last_timestamp = version_lookup_at(dirname).collect do |file|
+          File.basename(file).split("_").first.to_i
+        end.max.to_i
+
+        last_version = Dir.glob("#{dirname}/#{last_timestamp}_*").to_s.split('/').last
+        last_version = last_version.gsub(last_version[0..14], '')[0..-3].gsub('_', '.')
+
+        if last_version.empty?
+          return nil
+        else
+          return last_version
+        end        
+      end
+
+      def version_lookup_at(dirname)
+        Dir.glob("#{dirname}/[0-9]*_*")
+      end
+    end
+  end
+end

data/lib/release_notes.rb

@@ -0,0 +1,27 @@
+require 'rails'
+
+module ReleaseNotes
+  # Name of application using ReleaseNotes.
+  mattr_accessor :app_name
+  @@app_name = 'AppNameGoesHere'
+
+  # Version to start ReleaseNotes if there are none.
+  mattr_accessor :starting_version
+  @@starting_version = '0.1.0'
+
+  # Model name of the model created to store release notes.
+  mattr_accessor :release_note_model
+  @@release_note_model = 'ReleaseNote'
+
+  # Name of the folder where release notes are stored.
+  mattr_accessor :release_note_folder
+  @@release_note_folder = 'release_notes'
+
+  # Default way to setup ReleaseNotes. Run rails g release_notes:install
+  # to create a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+end
+
+require 'release_notes/engine'

data/release_notes.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'release_notes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "release_notes"
+  spec.version       = ReleaseNotes::VERSION
+  spec.authors       = ["Brandon Robins"]
+  spec.email         = ["brandon@ourlabel.com"]
+  spec.summary       = "An easy way to incorporate and manage release notes."
+  spec.description   = "An easy way to incorporate and manage release notes."
+  spec.homepage      = "http://www.github.com/eanlain/release_notes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables << 'release_notes'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "cucumber", "~> 1.3.10"
+  spec.add_development_dependency "aruba", "~> 0.5.4"
+
+  spec.add_dependency "thor", "~> 0.18.1"
+  spec.add_dependency "rails", "~> 4.0.0"
+  spec.add_dependency "redcarpet", "~> 3.0.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: release_notes
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Brandon Robins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: An easy way to incorporate and manage release notes.
+email:
+- brandon@ourlabel.com
+executables:
+- release_notes
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/release_notes/bootstrap.js
+- app/assets/stylesheets/release_notes/application.css
+- app/assets/stylesheets/release_notes/bootstrap.css
+- app/assets/stylesheets/release_notes/github.css.scss
+- app/controllers/release_notes/application_controller.rb
+- app/controllers/release_notes/release_notes_controller.rb
+- app/helpers/release_notes/application_helper.rb
+- app/views/layouts/release_notes/application.html.erb
+- app/views/release_notes/release_notes/_shared.html.erb
+- app/views/release_notes/release_notes/index.html.erb
+- app/views/release_notes/release_notes/show.html.erb
+- bin/release_notes
+- config/routes.rb
+- features/support/setup.rb
+- lib/generators/active_record/release_notes_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/release_notes/install_generator.rb
+- lib/generators/release_notes/orm_helpers.rb
+- lib/generators/release_notes/release_notes_generator.rb
+- lib/generators/release_notes/views_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/release_notes.rb
+- lib/generators/templates/update.md
+- lib/generators/templates/update_blank.md
+- lib/release_notes.rb
+- lib/release_notes/cli.rb
+- lib/release_notes/cli/helpers.rb
+- lib/release_notes/engine.rb
+- lib/release_notes/generators/release_note.rb
+- lib/release_notes/version.rb
+- lib/release_notes/versioning.rb
+- lib/release_notes/versioning/semantic.rb
+- release_notes.gemspec
+- spec/spec_helper.rb
+homepage: http://www.github.com/eanlain/release_notes
+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.2.1
+signing_key: 
+specification_version: 4
+summary: An easy way to incorporate and manage release notes.
+test_files:
+- features/support/setup.rb
+- spec/spec_helper.rb