release_notes 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4b4a4e8bf933a1dfd39666d985d945b745ac7d7
-  data.tar.gz: 42b99ef88c751918ff5e18c1dd69e78f76fb5be5
+  metadata.gz: 5ebff1dc3ba451c2edfed2a67328825c11ece400
+  data.tar.gz: d202b99c8ad32195bad01bb6f0d94179ac7614fc
 SHA512:
-  metadata.gz: 791430ac706055a30a97808aead68464764a50f644003a2f14447138324e1fd58d2d10378dfb971ea430ce2b38ff4b2463398a4cf38266c651f84866f4e667c7
-  data.tar.gz: 3c2f58bb077552783015e5822d8bd2fe33dc8244f1497e743a97b5acd187008bef7fe268152033b3d5439d13176160bd1673fa58c4e5ed255cba3883768cc441
+  metadata.gz: c1f6c8bf9b12f22fbc74a597740c031d862e42c3c3131de3f6c4b2e3bdad2c18b0ce6981059803ee3b3c1fb29d425154f3d18a41c3a63fe34244753a810ace0b
+  data.tar.gz: 77e4ca2480fe549a1986c0459f0c57d8a82252d011815546eb83ac7e24d65c5c047dc8eea4288defce4b4f911d8e4c7e1768ede098ce86cd38934a37f1374b2c

data/features/cli.feature

@@ -0,0 +1,101 @@
+Feature: Cli
+  In order to run ReleaseNotes from the command line
+  Cli commands must run properly
+
+  Background:
+    Given a Rails app named "hello_world" exists
+    And this gem "release_notes" is installed in the app
+    And this gem is ready to use
+
+
+  Scenario: Generate a new release note
+    Given I am in "tmp/hello_world"
+    And I run `release_notes new`
+    Then a directory named "release_notes" should exist
+    And a file matching %r<[0-9]*_0_1_0.md$> should exist
+
+
+  Scenario: Save a release note to the database
+    Given I am in "tmp/hello_world"
+    And I run `release_notes new`
+    Then a model named "ReleaseNote" should have "0" records
+
+    And I run `release_notes update`
+    Then a model named "ReleaseNote" should have "1" records
+
+
+  Scenario: Generate release note to a specific destination
+    Given I am in "tmp/hello_world"
+    And I run `release_notes new -d="whatwhat"`
+    Then a directory named "whatwhat" should exist
+    And a directory named "release_notes" should not exist
+    And a file matching %r<[0-9]*_0_1_0.md$> should exist
+
+
+  Scenario: Overwrite a previous release note
+    Given I am in "tmp/hello_world"
+    And I run `release_notes new`
+    And I run `release_notes new -v=0.1.0 -f`
+    Then a file matching %r<[0-9]*_0_1_0.md$> should exist
+
+
+  Scenario: Generate release notes in increments
+    Given I am in "tmp/hello_world"
+    And I run `release_notes new`
+    And I run `release_notes new -i=m`
+    Then a file matching %r<[0-9]*_0_2_0.md$> should exist
+
+    And I run `release_notes new -i=M`
+    Then a file matching %r<[0-9]*_1_0_0.md$> should exist
+
+    And I run `release_notes new -i=major`
+    Then a file matching %r<[0-9]*_2_0_0.md$> should exist
+
+    And I run `release_notes new -i=minor`
+    Then a file matching %r<[0-9]*_2_1_0.md$> should exist
+
+    And I run `release_notes new`
+    Then a file matching %r<[0-9]*_2_1_1.md$> should exist
+
+    And I run `release_notes update`
+    Then a model named "ReleaseNote" should have "6" records
+
+
+  Scenario: Runs ReleaseNotes interatively
+    Given I am in "tmp/hello_world"
+    When I run `release_notes new -m` interactively
+    And I type "a: This is a test!"
+    And I type "done"
+    And I type "Some summary statement..."
+    Then a directory named "release_notes" should exist
+    And a file matching "/release_notes/[0-9]*_0_1_0.md" should contain "Some summary statement..." 
+
+
+  Scenario: Update release notes in a specific directory
+    Given I am in "tmp/hello_world"
+    And I run `release_notes new`
+    And I run `release_notes new`
+    And I run `release_notes new -d=oye`
+    And I run `release_notes new -d=oye`
+    And I run `release_notes new -d=oye`
+    And I run `release_notes update -d=oye`
+    Then a model named "ReleaseNote" should have "3" records
+
+
+  Scenario: Use the given version
+    Given I am in "tmp/hello_world"
+    And I run `release_notes new -v=1.2.3`
+    Then a file matching %r<[0-9]*_1_2_3.md$> should exist
+
+
+  Scenario: Update release notes without creating a log
+    Given I am in "tmp/hello_world"
+    And I run `release_notes new`
+    And I run `release_notes update -n`
+    Then the file "release_notes/README.md" should not exist
+
+
+  Scenario: Returns the version of ReleaseNotes
+    Given I am in "tmp/hello_world"
+    When I run `release_notes -v`
+    Then the output from "release_notes -v" should contain "ReleaseNotes v"

data/features/generator.feature

@@ -0,0 +1,20 @@
+Feature: Generators
+  In order to run ReleaseNotes properly
+  Generators must run properly
+
+  Background:
+    Given a Rails app named "hello_world" exists
+    And this gem "release_notes" is installed in the app
+
+
+  Scenario: Generate ReleaseNotes initializer
+    Given I am in "tmp/hello_world"
+    When I run `rails generate release_notes:install`
+    Then the file "config/initializers/release_notes.rb" should exist
+   
+   
+  Scenario: Generate ReleaseNote migration
+    Given I am in "tmp/hello_world"
+    When I run `rails generate release_notes ReleaseNote`
+    Then a file matching %r<[0-9]*_release_notes_create_release_notes.rb$> should exist
+    And the file "config/routes.rb" should contain "mount ReleaseNotes::Engine, at: '/release_notes', :as => 'release_notes'"

data/features/step_definitions/feature_steps.rb

@@ -0,0 +1,122 @@
+# Creates an app and sets the RAILS_ROOT and navigates to that app's root
+Given /^a Rails app named "([^\"]*)" exists$/ do |app_name|
+  @app_name = app_name
+  step "I successfully run `rm -rf #{app_name}`" # ensure working directory is clean
+  step "a directory named \"#{app_name}\" should not exist"
+  step "I successfully run `rails new #{app_name}`"
+
+  ENV["RAILS_ENV"] ||= "test"
+  require File.expand_path("../../../tmp/hello_world/config/environment.rb",  __FILE__)
+  ENV["RAILS_ROOT"] ||= File.dirname(__FILE__) + "/tmp/hello_world"
+  
+  step "I cd to \"#{app_name}\""
+end
+
+When /^this gem "([^\"]*)" is installed in the app$/ do |gem_name|
+  gem_path = File.expand_path('../../../', __FILE__)
+  step "I append to \"Gemfile\" with \"gem '#{gem_name}', :path => '#{gem_path}'\""
+  step "I successfully run `bundle check`"
+end
+
+When /^this gem is ready to use$/ do
+  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'db/test.sqlite3')
+
+  step "I run `rails generate release_notes:install`"
+  step "I run `rails generate release_notes ReleaseNote`"
+  step "I run `rake db:migrate`"
+end
+
+Then /^a file matching "([^\"]*)" should contain "([^\"]*)"$/ do |simple_regex, partial_content|
+  file = Dir[[@basedir, simple_regex].join][0]
+  file.slice! @basedir + '/'
+  check_file_content(file, partial_content, true)
+end
+
+Then /^a model named "([^\"]*)" should have "([0-9]+)" records$/ do |model_name, record_count|
+  expect(model_name.constantize.count).to eq(record_count.to_i)
+end
+
+Given /^I am in "([^\"]*)"$/ do |directory|
+  @basedir = directory
+end
+
+Given /^the file "([^\"]*)" exists$/ do |filename|
+  expect(File.exists?(File.join(@basedir, filename))).to eq(true)
+end
+
+When /^I copy the file "([^\"]*)" to "([^\"]*)"$/ do |src, dest|
+  FileUtils.cp(File.join(@basedir, src), File.join(@basedir, dest))
+end
+
+Then /^the file "([^\"]*)" should exist$/ do |filename|
+  expect(File.exists?(File.join(@basedir, filename))).to eq(true)
+end
+
+Given /^the following files exist:$/ do |table|
+  (@files_i_care_about || table.hashes).each do |file|
+    expect(File.exists?(File.join(@basedir, file["filename"]))).to eq(true)
+  end
+end
+
+When /^I copy the following files to "([^\"]*)":$/ do |destination, table|
+  table.hashes.each do |file|
+    filename = File.join(@basedir, file["filename"])
+    FileUtils.cp(filename, destination)
+  end
+end
+
+Then /^the following files should exist in "([^\"]*)":$/ do |destination, table|
+  table.hashes.each do |file|
+    expect(File.exists?(File.join(destination, file["filename"]))).to eq(true)
+  end
+end
+
+When /^I create the directory "([^\"]*)"$/ do |directory|
+  FileUtils.mkdir_p(directory).should_not be_nil
+end
+
+Given /^the following table of (.+):$/ do |name, table|
+  @tables = {}
+  @tables[name] = table.hashes
+end
+
+When /^I copy the (.+) in the table to "([^\"]*)"$/ do |name, destination|
+  @tables[name].each do |file|
+    filename = File.join(@basedir, file["filename"])
+    FileUtils.cp(filename, destination)
+  end
+end
+
+Then /^the (.+) in the table should exist in "([^\"]*)"$/ do |name, destination|
+  @tables[name].each do |file|
+    expect(File.exists?(File.join(destination, file["filename"]))).to eq(true)
+  end
+end
+
+When /^I copy files beginning with the letters (\S+) to "([^\"]*)"$/ do |pattern, destination|
+  patterns = pattern.split(',')
+  @filelist = []
+  @destination = destination
+  patterns.each do |pattern|
+    glob = Dir.glob(File.join(@basedir, "#{pattern}*"))
+
+    actual_files = glob.find_all do |filename| 
+      File.file?(filename)
+    end
+
+    @filelist << actual_files.map do |filename| 
+      File.basename(filename) 
+    end
+  end
+  @filelist.flatten!
+  @filelist.each do |filename|
+    FileUtils.cp(File.join(@basedir, filename), @destination)
+  end
+end
+
+Then /^they should exist there$/ do
+  raise unless @filelist && @destination
+  @filelist.each do |filename|
+    expect(File.exists?(File.join(@destination, filename))).to eq(true)
+  end
+end

data/features/support/setup.rb

@@ -1 +1,8 @@
-require 'aruba/cucumber'
+require 'aruba/cucumber'
+require 'pry'
+require 'rails'
+
+Before do
+  @aruba_timeout_seconds = 20
+  @dirs = ["tmp"]
+end

data/lib/release_notes/cli.rb

@@ -111,7 +111,7 @@ module ReleaseNotes
     desc 'version', 'Show version of release_notes'
 
     def version
-      puts "ReleaseNotes #{ReleaseNotes::VERSION}"
+      puts "ReleaseNotes v#{ReleaseNotes::VERSION}"
     end
 
 

data/lib/release_notes/version.rb

@@ -1,3 +1,3 @@
 module ReleaseNotes
-  VERSION = "0.5.1"
+  VERSION = "1.0.0"
 end

data/release_notes.gemspec

@@ -25,7 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bootstrap-sass", "~> 3.2.0"
   spec.add_dependency "redcarpet", "~> 3.0.0"
 
+  spec.add_development_dependency "pry-rails"
   spec.add_development_dependency "rspec-rails", "~> 3.0.0"
   spec.add_development_dependency "factory_girl_rails", "~> 4.4.1"
+  spec.add_development_dependency "aruba", "~> 0.6.0"
   spec.add_development_dependency "sqlite3"
 end

data/spec/controllers/release_notes/release_notes_controller_spec.rb

@@ -48,7 +48,7 @@ module ReleaseNotes
       it "assigns @release_notes" do
         get :show, { version: @release_note.version, use_route: :release_notes }
 
-        expect(assigns(:release_notes)).to eq(@release_note)
+        expect(assigns(:release_notes)).to eq([@release_note])
       end
     end
   end

data/spec/dummy/release_notes/20140715165429_1_0_0.md

@@ -0,0 +1,17 @@
+# Demo App 1.0.0 Release Notes
+###### Full test coverage, I think...
+
+#### 07/15/2014
+
+Additions
+----
+* Added Cucumber generator tests.
+* Added Cucumber CLI tests.
+
+
+
+
+
+
+
+*the end*

data/spec/dummy/release_notes/README.md

@@ -1,3 +1,51 @@
+# Demo App 1.0.0 Release Notes
+###### Full test coverage, I think...
+
+#### 07/15/2014
+
+Additions
+----
+* Added Cucumber generator tests.
+* Added Cucumber CLI tests.
+
+
+
+
+
+
+
+*the end*
+
+---
+
+# Demo App 0.5.1 Release Notes
+###### Added release_note_indicator helper.
+
+#### 07/13/2014
+
+Additions
+----
+* Added release_note_indicator helper.
+* Added release_note_indicator snippet to dummy app view.
+
+Changes
+----
+* Updated gemspec.
+* Updated README.
+
+Fixes
+----
+* Fixed a template error that occurred when trying to navigate to a specific release note by version.
+
+Upcoming
+----
+* Add generator tests.
+* Add command line tests.
+
+*the end*
+
+---
+
 # Demo App 0.5.1 Release Notes
 ###### Added release_note_indicator helper.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release_notes
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Brandon Robins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-13 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.4.1
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -132,7 +160,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -149,6 +176,9 @@ files:
 - app/views/release_notes/release_notes/show.html.erb
 - bin/release_notes
 - config/routes.rb
+- features/cli.feature
+- features/generator.feature
+- features/step_definitions/feature_steps.rb
 - features/support/setup.rb
 - lib/generators/active_record/release_notes_generator.rb
 - lib/generators/active_record/templates/release_notes_migration.rb
@@ -220,6 +250,7 @@ files:
 - spec/dummy/release_notes/20140703165131_0_4_0.md
 - spec/dummy/release_notes/20140703165820_0_5_0.md
 - spec/dummy/release_notes/20140713050803_0_5_1.md
+- spec/dummy/release_notes/20140715165429_1_0_0.md
 - spec/dummy/release_notes/README.md
 - spec/dummy/release_notes/stamp
 - spec/factories/release_notes.rb
@@ -252,6 +283,9 @@ signing_key:
 specification_version: 4
 summary: An easy way to incorporate and manage release notes.
 test_files:
+- features/cli.feature
+- features/generator.feature
+- features/step_definitions/feature_steps.rb
 - features/support/setup.rb
 - spec/controllers/release_notes/release_notes_controller_spec.rb
 - spec/dummy/README.rdoc
@@ -304,6 +338,7 @@ test_files:
 - spec/dummy/release_notes/20140703165131_0_4_0.md
 - spec/dummy/release_notes/20140703165820_0_5_0.md
 - spec/dummy/release_notes/20140713050803_0_5_1.md
+- spec/dummy/release_notes/20140715165429_1_0_0.md
 - spec/dummy/release_notes/README.md
 - spec/dummy/release_notes/stamp
 - spec/factories/release_notes.rb

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.0.0-p353@eanlain