release_notes 0.2.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20abfeb2d8d618567392ea7156dfa4e016c20e74
-  data.tar.gz: 2b2c81dff9b96eb2514d8aaa5108ca659861e691
+  metadata.gz: b87726f5ce617cdc8a5c2d09c794065c8c2c1a45
+  data.tar.gz: b0bb70f0a18b2b054a0850e2a27215a9f64d81d8
 SHA512:
-  metadata.gz: 671c1ec3281ac5efc43f3774331c894e6b77977231e9a36eb65ed62002fbda49c74409b0033a5c6c45191cd49d623654e00bb8a0c710f27ee8f36a46e9d69ebf
-  data.tar.gz: c07497b81b5e373f5bfc17480eb2de0522bb082edd4c9dd652b503ee1b26bdfcbca7c8ffc9c62907ea0fdafe7999565adea5b47a6d0938638b27810619daa9de
+  metadata.gz: d4e23f0fd107133ddd37aad19a4e10d906092ffe289a5f3074c9e2e6e0f9ac2acbc7b7f71bae4a9d7e71f3dbe836d42c23e57151ea444f371600590172836ec0
+  data.tar.gz: 1fd93580d20818e7bee849a10b5fe1bed9e7f3db09966e219d4330f1eebe1b435459395593df14875e25f7889e672a14c616e47cab98cc28516a36ec845e4c2e

data/README.md

@@ -18,15 +18,15 @@ Or install it yourself as:
 
 ## Getting Started
 
-After installing ReleaseNotes you need to run the install generator:
+If you're looking to use ReleaseNotes with Rails you will need to run the install generator:
 
     $ rails generate release_notes:install
 
-The generator will install an initializer containing ReleaseNotes various configuration options. When you are done, you are ready to add a ReleaseNote model to using the following generator:
+The generator will install a ReleaseNotes initializer containing various configuration options and a ReleaseNotes controller decorator. When you are done, you are ready to add a ReleaseNote model to using the following generator:
 
     $ rails generate release_notes ReleaseNote
 
-This will generate a model named `ReleaseNote` in your Rails project. You can choose to use a different model name, but after doing so you must update `config.release_note_model` in the `config/initializers/release_notes.rb` file with the name of the model you generated.
+This will generate a model named `ReleaseNote` in your Rails project and will add a route in your `config/routes.rb` file at `/release_notes`. You can choose to use a different model name, but after doing so you must update `config.release_note_model` in the release_notes initializer with the name of the model you generated.
 
 Be sure to migrate your database.
 
@@ -40,19 +40,19 @@ To add the ability to display broadcasts of new releases (or any other messages)
 
     $ rails generate release_notes:broadcasts Broadcast
 
-This will generate a model named `Broadcast` in your Rails project. As mentioned before, you can choose to use a different model name, but remember to edit the `config/initializers/release_notes.rb` file with the name.
+This will generate a model named `Broadcast` in your Rails project. You can choose to use a different model name, but you must edit the release_notes initializer file with the updated Broadcast name.
 
 Migrate your database.
 
     $ rake db:migrate
 
-Add the following to your layout/application.html.erb file
+Then add one of the following render tags to whichever view you'd like to display the broadcast message in.
 
-    <%= stylesheet_link_tag "release_notes/application", media: "all" %>
+    <%= render 'release_notes/broadcasts/link_back' %>
 
-Then add the following render to wherever you'd like to display the broadcast message.
+OR...
 
-    <%= render 'release_notes/broadcasts/shared' %>
+    <%= render 'release_notes/broadcasts/bare' %>
 
 #### Views
 
@@ -60,6 +60,17 @@ While not necessary, you may want to copy over the ReleaseNotes views to your ap
 
     $ rails generate release_notes:views
 
+If you do decide to customize the ReleaseNotes views and want to use your own layout you should probably **(1)** edit the layout declaration in `app/decorators/controllers/release_notes/release_notes_controller_decorator.rb` and **(2)** add one of the following stylesheet_link_tag snippets to your view:
+
+    <%= stylesheet_link_tag "release_notes/application", media: "all" %>
+
+Will load Bootstrap 3 and a [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) style.
+
+    <%= stylesheet_link_tag "release_notes/github", media: "all" %>
+
+Will load just the [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) style.
+
+
 ## Usage
 
 ### Generate a new release note template
@@ -68,7 +79,7 @@ To create a new release note run the following:
 
     $ release_notes new
 
-A new release note markdown file will be generated in the `release_notes` folder. Open the file in your favorite editor and fill out the relevant sections to your heart's content.
+A new release note markdown file will be generated and saved to the `release_notes` folder. Open the file in your favorite editor and fill out the relevant sections to your heart's content.
 
 ### Generate a new release note from the console
 
@@ -84,7 +95,11 @@ After finalizing your release note markdown file be sure to update your ReleaseN
 
     $ release_notes update
 
-If you ever want to reset your model - maybe you've gone back and edited a previous release note - you can rebuild the ReleaseNote model by running `release_notes update -r` appending the `-r` option. 
+If you ever want to update a particular release note you can run the following, where `VERSION` is the specific release note version that you want to update.
+
+    $ release_notes update -v=VERSION
+
+This will only update the release note matching the version number specified.
 
 ### View release notes in your application
 
@@ -97,6 +112,7 @@ To create a new Broadcast run:
     $ release_notes broadcast new
 
 This will generate a broadcast markdown file which you can edit.
+**Note:** You *can* use HTML within the markdown file.
 
 ### Update Broadcast
 
@@ -104,7 +120,17 @@ After finalizing your broadcast markdown file be sure to update your Broadcast m
 
     $ release_notes broadcast update
 
-If you ever want to reset your model - maybe you've gone back and edited a previous release note - you can rebuild the Broadcast model by running `release_notes broadcast update -r` appending the `-r` option.
+If you ever want to update a particular broadcast you can run the following:
+
+    $ release_notes broadcast update -v=VERSION
+
+### Set a Broadcast
+
+You can set a specific broadcast to set as the "latest" broadcast (the default shown by using the broadcast partials) by running the following:
+
+    $ release_notes broadcast set_version VERSION
+
+The "latest" version will be set to the `VERSION` specified.
 
 ## Contributing
 

data/app/helpers/release_notes/application_helper.rb

@@ -15,7 +15,7 @@ module ReleaseNotes
                            :quote => true,
                            :footnotes => true]
 
-      render_options = [:filter_html => true,
+      render_options = [:filter_html => false,
                         :hard_wrap => true,
                         :prettify => true]
 

data/app/views/release_notes/broadcasts/{_shared.html.erb → _bare.html.erb}

@@ -2,9 +2,4 @@
   <div>
     <%= markup(ReleaseNotes.broadcast_model.constantize.last.markdown).html_safe %>
   </div>
-  <div>
-    <a href="/<%= ReleaseNotes.mount_at %>">
-      View all release notes
-    </a>
-  </div>
 <% end %>

data/app/views/release_notes/broadcasts/_link_back.html.erb

@@ -0,0 +1,6 @@
+<%= render 'release_notes/broadcasts/bare' %>
+<div>
+  <a href="/<%= ReleaseNotes.mount_at %>">
+    View all release notes
+  </a>
+</div>

data/lib/generators/active_record/broadcasts_generator.rb

@@ -13,7 +13,7 @@ module ActiveRecord
         if (behavior == :invoke && model_exists?)
           raise "#{table_name} already exists..."
         else
-          migration_template "broadcasts_migration.rb", "db/migrate/release_notes_create_#{table_name}"
+          migration_template "broadcasts_migration.rb", "db/migrate/release_notes_create_#{table_name}.rb"
         end
       end
 

data/lib/generators/active_record/release_notes_generator.rb

@@ -13,7 +13,7 @@ module ActiveRecord
         if (behavior == :invoke && model_exists?)
           raise "#{table_name} already exists..."
         else
-          migration_template "release_notes_migration.rb", "db/migrate/release_notes_create_#{table_name}"
+          migration_template "release_notes_migration.rb", "db/migrate/release_notes_create_#{table_name}.rb"
         end
       end
 

data/lib/generators/release_notes/install_generator.rb

@@ -13,6 +13,10 @@ module ReleaseNotes
         template "release_notes.rb", "config/initializers/release_notes.rb"
       end
 
+      def copy_controller_decorator
+        template "release_notes_controller_decorator.rb", "app/decorators/controllers/release_notes/release_notes_controller_decorator.rb"
+      end
+
       def show_readme
         readme "README" if behavior == :invoke
       end

data/lib/generators/templates/broadcast_blank.md

@@ -1,3 +1,3 @@
-### [<%= @subject -%>](/<%= ReleaseNotes.mount_at %><% if !@release_note_version.nil? %>/<%= @release_note_version %><% end %>)
+### <% if @release_note_version.nil? -%><%= @subject -%><% else -%>[<%= @subject -%>](/<%= ReleaseNotes.mount_at -%>/<%= @release_note_version -%>)<% end -%>
 
 <%= @body -%>

data/lib/generators/templates/release_notes.rb

@@ -9,6 +9,12 @@ ReleaseNotes.setup do |config|
   # Name of the model you're using to store broadcasts.
   config.broadcast_model = 'Broadcast'
 
+  # Name of the model you're using to store users.
+  config.user_model = 'User'
+
+  # Name of the model you're using to store broadcasts for users.
+  config.user_broadcast_model = 'UserBroadcast'
+
   # Name of the folder you're using to store the release note and broadcast markdown files.
   config.release_note_folder = 'release_notes'
 

data/lib/generators/templates/release_notes_controller_decorator.rb

@@ -0,0 +1,3 @@
+ReleaseNotes::ReleaseNotesController.class_eval do
+  layout 'release_notes/application'
+end

data/lib/release_notes.rb

@@ -17,6 +17,14 @@ module ReleaseNotes
   mattr_accessor :broadcast_model
   @@broadcast_model = 'Broadcast'
 
+  # Model name of the model created to store users.
+  mattr_accessor :user_model
+  @@user_model = 'User'
+
+  # Model name of the model created to store broadcasts for users.
+  mattr_accessor :user_broadcast_model
+  @@user_broadcast_model = 'UserBroadcast'
+
   # Name of the folder where release notes are stored.
   mattr_accessor :release_note_folder
   @@release_note_folder = 'release_notes'

data/lib/release_notes/cli.rb

@@ -20,7 +20,7 @@ module ReleaseNotes
     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 - "major", "minor", "patch"'
     method_option :message, :aliases => '-m', :desc => 'interactive release note bullet input'
-    method_option :version, :aliases => '-V', :desc => 'use the given version number'
+    method_option :version, :aliases => '-v', :desc => 'use the given version number'
 
     def new
       if options[:version].nil?
@@ -47,7 +47,7 @@ module ReleaseNotes
     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'
+    # 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

data/lib/release_notes/cli/broadcast.rb

@@ -1,22 +1,43 @@
 module ReleaseNotes
   class Broadcast < Thor
-    desc 'new', 'Create a new broadcast'
+    desc 'broadcast new', 'Create a new broadcast'
     method_option :destination, :aliases => '-d', :default => ReleaseNotes.release_note_folder, :desc => 'relative location of release note folder'
-    method_option :body, :aliases => '-b', :default => "We've made some new changes - check 'em out!", :desc => 'body of broadcast'
-    method_option :subject, :aliases => '-s', :default => "New Update", :desc => 'subject of broadcast'
     method_option :release_note_version, :aliases => '-r', :desc => 'corresponding release note version'
+    method_option :subject, :aliases => '-s', :default => "New Update", :desc => 'subject of broadcast'
+    method_option :body, :aliases => '-b', :default => "We've made some new changes - check 'em out!", :desc => 'body of broadcast'
 
     def new
+      release_note_version = options[:release_note_version] || ""
+
       ReleaseNotes::Generators::Broadcast.start([options[:destination],
                                                  options[:subject],
                                                  options[:body],
-                                                 options[:release_note_version]])
+                                                 release_note_version])
+    end
+
+
+    desc 'broadcast set_version [VERSION]', 'Sets the latest broadcast to the given version'
+
+    def set_version(version)
+      rn = ReleaseNotes.broadcast_model.constantize.find_by(version: version)
+      
+      new_rn = ReleaseNotes.broadcast_model.constantize.new
+      new_rn.version = rn.version
+      new_rn.markdown = rn.markdown
+
+      rn.destroy
+      new_rn.save
+
+      say "Latest broadcast is now set to version #{version}.", :green
+    rescue NoMethodError
+      say "Broadcast version #{version} was not found in the db.", :red
     end
 
 
-    desc 'update', "Update #{ReleaseNotes.broadcast_model} models"
+    desc 'broadcast update', "Update #{ReleaseNotes.broadcast_model} models"
     method_option :destination, :aliases => '-d', :default => ReleaseNotes.release_note_folder, :desc => 'relative location of release note folder'
     method_option :reset, :aliases => '-r', :type => :boolean, :default => false, :desc => 'delete all model entries and rebuilds them'
+    method_option :version, :aliases => '-v', :desc => 'specific broadcast version to save/update'
 
     def update
       # If reset option is passed delete all broadcasts in model
@@ -26,29 +47,49 @@ module ReleaseNotes
         end
       end
 
-      # Gets last broadcast version from db
-      last_broadcast = ReleaseNotes.broadcast_model.constantize.last
+      if options[:version]
+        version = options[:version]
+        broadcast_file = single_broadcast_lookup_at(options[:destination], version)
+        markdown = File.read("#{options[:destination]}/#{broadcast_file}")
 
-      if last_broadcast.nil?
-        last_version = 0
-      else
-        last_version = last_broadcast.version.to_i
-      end
-      
-      # Collects relevant files and saves version and content to db
-      broadcast_files = collect_broadcast_files(options[:destination])
-      broadcast_files.each do |file|
-        version = file.split('_').last.to_i
-        
-        if version > last_version
-          markdown = File.read("#{options[:destination]}/#{file}")
+        # If version is set check to see if its already in db or create new one
+        if ReleaseNotes.broadcast_model.constantize.find_by(version: version)
+          ReleaseNotes.broadcast_model.constantize
+                      .find_by(version: version)
+                      .update_attributes(markdown: markdown)
 
+          say "#{ReleaseNotes.broadcast_model} model successfully updated.", :green
+        else
           ReleaseNotes.broadcast_model.constantize.create(version: version,
                                                           markdown: markdown)
+
+          say "#{ReleaseNotes.broadcast_model} model successfully saved.", :green
         end
-      end
+      else
+        # Gets last broadcast version from db
+        last_broadcast = ReleaseNotes.broadcast_model.constantize.last
 
-      say "#{ReleaseNotes.broadcast_model} model successfully updated.", :green
+        if last_broadcast.nil?
+          last_version = 0
+        else
+          last_version = last_broadcast.version.to_i
+        end
+        
+        # Collects relevant files and saves version and content to db
+        broadcast_files = collect_broadcast_files(options[:destination])
+        broadcast_files.each do |file|
+          version = file.split('_').last.to_i
+          
+          if version > last_version
+            markdown = File.read("#{options[:destination]}/#{file}")
+
+            ReleaseNotes.broadcast_model.constantize.create(version: version,
+                                                            markdown: markdown)
+
+            say "#{ReleaseNotes.broadcast_model} version #{version} successfully saved.", :green
+          end
+        end
+      end
     end
 
     protected
@@ -65,7 +106,11 @@ module ReleaseNotes
       end
 
       def broadcast_lookup_at(dirname)
-        Dir.glob("#{dirname}/*_[0-9]*.md")
+        Dir.glob("#{dirname}/broadcast_[0-9]*.md")
+      end
+
+      def single_broadcast_lookup_at(dirname, version)
+        File.basename(Dir.glob("#{dirname}/broadcast_#{version}*.md")[0])
       end
   end
 end

data/lib/release_notes/engine.rb

@@ -2,6 +2,12 @@ module ReleaseNotes
   class Engine < ::Rails::Engine
     isolate_namespace ReleaseNotes
 
+    config.to_prepare do
+      Dir.glob(Rails.root + "app/decorators/**/release_notes/*_decorator*.rb").each do |c|
+        require_dependency(c)
+      end
+    end
+
     initializer 'release_notes.action_controller' do |app|
       ActiveSupport.on_load :action_controller do
         helper ReleaseNotes::ApplicationHelper

data/lib/release_notes/generators/broadcast.rb

@@ -15,7 +15,13 @@ module ReleaseNotes
       def set_local_assigns
         @subject = subject
         @body = body
-        @release_note_version = release_note_version.gsub('.', '_')
+
+        if release_note_version != ""
+          @release_note_version = release_note_version.gsub('.', '_')
+        else
+          @release_note_version = nil
+        end
+        
         @broadcast_template = 'broadcast_blank.md'
         @destination = File.expand_path(destination)
       end

data/lib/release_notes/version.rb

@@ -1,3 +1,3 @@
 module ReleaseNotes
-  VERSION = "0.2.1"
+  VERSION = "0.3.3"
 end

data/release_notes.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
   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 "rails", "> 3.0.0"
   spec.add_dependency "redcarpet", "~> 3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release_notes
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Brandon Robins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,16 +98,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>'
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>'
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +145,8 @@ files:
 - 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/broadcasts/_shared.html.erb
+- app/views/release_notes/broadcasts/_bare.html.erb
+- app/views/release_notes/broadcasts/_link_back.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
@@ -164,6 +165,7 @@ files:
 - lib/generators/templates/README
 - lib/generators/templates/broadcast_blank.md
 - lib/generators/templates/release_notes.rb
+- lib/generators/templates/release_notes_controller_decorator.rb
 - lib/generators/templates/update.md
 - lib/generators/templates/update_blank.md
 - lib/release_notes.rb
@@ -205,3 +207,4 @@ summary: An easy way to incorporate and manage release notes.
 test_files:
 - features/support/setup.rb
 - spec/spec_helper.rb
+has_rdoc: