release_notes 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 693a9c73e2241120056f4676c9da2944dcb0e2ce
-  data.tar.gz: 9cd136e107570674a7eb1272bc54d879b13afadc
+  metadata.gz: 944aabbdcfbe98177f96767bacfb25ac122628fa
+  data.tar.gz: 6b6eb9634870439af6a73a2c1192af44a3025e62
 SHA512:
-  metadata.gz: c37e57a7948fab39d3886add8a6f8c542d915e71b4a7bdf7d3cef58f5afb4e53875daf80f35db7aa93a5cd032c7eb622cc0c6c11b59eb0baa4c2575490ad74f4
-  data.tar.gz: 5a9da389aeb6b4615df33c2928c723a1bf4b1b47200ac0025b9f935dc74eb07850138528fae4c48f5629f69e29a2ec2ee65be5c9dae0f34bfd01d584c5f6fe14
+  metadata.gz: d98b8739536d1be288b3a69cb8225872064ae22d2cc7107f961271b807c58caa5f4324995a5fb7c2747bdb1353a4711f7a800268bd8b28e818b4f44d94b27a00
+  data.tar.gz: dbb63344fd67d55c0b0953c6e78406b6173de94f69ef6eb5fe1b6b54e9e5b5b1a96774f0b7b9c1c4170dfc73c461a046b8ec740640b99c7889a9260c134978c0

data/README.md

@@ -32,7 +32,31 @@ Be sure to migrate your database.
 
     $ rake db:migrate
 
-*Optional:* While not necessary, you may want to copy over the ReleaseNotes views to your app to customize:
+### Optional
+
+#### Broadcasts
+
+To add the ability to display broadcasts of new releases (or any other messages) run the following:
+
+    $ 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.
+
+Migrate your database.
+
+    $ rake db:migrate
+
+Add the following to your layout/application.html.erb file
+
+    <%= stylesheet_link_tag "release_notes/application", media: "all" %>
+
+Then add the following render to wherever you'd like to display the broadcast message.
+
+    <%= render 'release_notes/broadcasts/shared' %>
+
+#### Views
+
+While not necessary, you may want to copy over the ReleaseNotes views to your app to customize:
 
     $ rails generate release_notes:views
 
@@ -66,6 +90,22 @@ If you ever want to reset your model - maybe you've gone back and edited a previ
 
 To view all of your release notes just visit `http://yourapp/release_notes` (or whatever route is mounted in your `routes.rb` file) in your application. To view a specific version just visit `http://yourapp/release_notes/:version` where `:version` is the release notes version that you are looking to view using underscores instead of periods (i.e. `0_1_0`).
 
+### Create a new Broadcast
+
+To create a new Broadcast run:
+
+    $ release_notes broadcast new
+
+This will generate a broadcast markdown file which you can edit.
+
+### Update Broadcast
+
+After finalizing your broadcast markdown file be sure to update your Broadcast model by running:
+
+    $ 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.
+
 ## Contributing
 
 1. Fork it ( http://github.com/eanlain/release_notes/fork )

data/app/assets/stylesheets/release_notes/application.css

@@ -12,6 +12,18 @@
  *= require_directory .
  */
 
+html,
+body {
+  height: 100%;
+}
+
+#wrap {
+  min-height: 100%;
+  height: auto;
+  margin: 0 auto -60px;
+  padding: 0 0 60px;
+}
+
 body {
   padding-top: 20px;
   padding-bottom: 20px;
@@ -35,6 +47,7 @@ body {
 }
 
 .footer {
+  height: 60px;
   padding-top: 19px;
   color: #777;
   border-top: 1px solid #e5e5e5;
@@ -56,6 +69,7 @@ body {
 
 .note {
   margin: 40px 0;
+  border-radius: 10px;
 }
 
 .note p + h4 {

data/app/assets/stylesheets/release_notes/github.css.scss

@@ -1,5 +1,3 @@
-
-
 .release {
   background: #EEE;
   border-radius: 3px;

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

@@ -0,0 +1,10 @@
+<% if ReleaseNotes.broadcast_model.constantize.last %>
+  <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/bin/release_notes

@@ -4,7 +4,7 @@ begin
   require File.expand_path('config/environment.rb')
   require File.expand_path('config/initializers/release_notes.rb')
 rescue LoadError
-  puts "Not in Rails root, or just can't find it... that's cool though - using default settings instead."
+  puts "Can't find config/initializers/release_notes.rb... that's cool though - using default settings instead."
 end
 
 require 'release_notes/cli'

data/lib/generators/active_record/broadcasts_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/active_record'
+require 'generators/release_notes/orm_helpers'
+
+module ActiveRecord
+  module Generators
+    class BroadcastsGenerator < ActiveRecord::Generators::Base
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      include ReleaseNotes::Generators::OrmHelpers
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_broadcasts_migration
+        if (behavior == :invoke && model_exists?)
+          raise "#{table_name} already exists..."
+        else
+          migration_template "broadcasts_migration.rb", "db/migrate/release_notes_create_#{table_name}"
+        end
+      end
+
+      def generate_module
+        invoke "active_record:model", [name], :migration => false unless model_exists? && behavior == :invoke
+      end
+
+      def inject_broadcasts_content
+        content = broadcasts_model_contents
+
+        class_path = if namespaced?
+          class_name.to_s.split("::")
+        else
+          [class_name]
+        end
+
+        indent_depth = class_path.size - 1
+        content = content.split("\n").map { |line| " " * indent_depth + line }.join("\n") << "\n"
+
+        inject_into_class(model_path, class_path.last, content) if model_exists?
+      end
+
+      def migration_data
+<<RUBY
+      t.text :markdown,     :null => false
+      t.string :version,    :null => false
+RUBY
+      end
+    end
+  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 "migration.rb", "db/migrate/release_notes_create_#{table_name}"
+          migration_template "release_notes_migration.rb", "db/migrate/release_notes_create_#{table_name}"
         end
       end
 
@@ -22,7 +22,7 @@ module ActiveRecord
       end
 
       def inject_release_notes_content
-        content = model_contents
+        content = release_notes_model_contents
 
         class_path = if namespaced?
           class_name.to_s.split("::")

data/lib/generators/active_record/templates/broadcasts_migration.rb

@@ -0,0 +1,13 @@
+class ReleaseNotesCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+<%= migration_data -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/release_notes/broadcasts_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/named_base'
+
+module ReleaseNotes
+  module Generators
+    class BroadcastsGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      namespace "release_notes:broadcasts"
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates a Broadcast model with the given NAME (if one does not exist)."
+
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/release_notes/orm_helpers.rb

@@ -1,10 +1,17 @@
 module ReleaseNotes
   module Generators
     module OrmHelpers
-      def model_contents
+      def release_notes_model_contents
         buffer = <<-CONTENT
-  validates :version, presence: true,
-                      uniqueness: true
+  validates :version, presence: true, uniqueness: true
+CONTENT
+        buffer
+      end
+
+      def broadcasts_model_contents
+        buffer = <<-CONTENT
+  validates :markdown, presence: true
+  validates :version, presence: true, uniqueness: true
 CONTENT
         buffer
       end

data/lib/generators/release_notes/release_notes_generator.rb

@@ -8,15 +8,15 @@ module ReleaseNotes
       namespace "release_notes"
       source_root File.expand_path("../templates", __FILE__)
 
-      desc "Generates a model with the given NAME (if one does not exist) with " <<
-           "release_notes configuration plus a migration file and release_notes routes."
+      desc "Generates a ReleaseNote model with the given NAME (if one does not exist) with " <<
+           "release_notes configuration plus release_notes routes."
 
       hook_for :orm
 
       class_option :routes, :desc => "Generate routes", :type => :boolean, :default => true
 
       def add_release_notes_routes
-        release_notes_routes = "mount ReleaseNotes::Engine, at: '/#{plural_name}'"
+        release_notes_routes = "mount ReleaseNotes::Engine, at: '/#{plural_name}', :as => '#{ReleaseNotes.mount_at}'"
 
         route release_notes_routes
       end

data/lib/generators/templates/broadcast_blank.md

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

data/lib/generators/templates/release_notes.rb

@@ -1,14 +1,20 @@
 # Use this hook to configure ReleaseNotes.
 ReleaseNotes.setup do |config|
-  # The name of your application.
+  # Name of your application.
   config.app_name = 'Application Name Goes Here'
 
-  # The name of the model you're using to store the various release notes.
+  # Name of the model you're using to store the various release notes.
   config.release_note_model = 'ReleaseNote'
 
-  # The name of the folder you're using to store the release note markdown files.
+  # Name of the model you're using to store broadcasts.
+  config.broadcast_model = 'Broadcast'
+
+  # Name of the folder you're using to store the release note and broadcast markdown files.
   config.release_note_folder = 'release_notes'
 
-  # The version number that the first ReleaseNote should start at.
+  # Path that ReleaseNotes::Engine is mounted at in the config/routes.rb file.
+  config.mount_at = 'release_notes'
+
+  # Version number that the first ReleaseNote should start at.
   config.starting_version = '0.1.0'
 end

data/lib/release_notes/cli/broadcast.rb

@@ -0,0 +1,71 @@
+module ReleaseNotes
+  class Broadcast < Thor
+    desc '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'
+
+    def new
+      ReleaseNotes::Generators::Broadcast.start([options[:destination],
+                                                 options[:subject],
+                                                 options[:body],
+                                                 options[:release_note_version]])
+    end
+
+
+    desc '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'
+
+    def update
+      # If reset option is passed delete all broadcasts in model
+      if options[:reset]
+        ReleaseNotes.broadcast_model.constantize.all.each do |b|
+          b.destroy
+        end
+      end
+
+      # Gets last broadcast version from db
+      last_broadcast = ReleaseNotes.broadcast_model.constantize.last
+
+      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)
+        end
+      end
+
+      say "#{ReleaseNotes.broadcast_model} model successfully updated.", :green
+    end
+
+    protected
+      def collect_broadcast_files(dirname)
+        broadcast_lookup_at(dirname).collect do |file|
+          File.basename(file)
+        end
+      end
+
+      def current_broadcast_number(dirname)
+        broadcast_lookup_at(dirname).collect do |file|
+          File.basename(file).split('_').last.to_i
+        end.max.to_i
+      end
+
+      def broadcast_lookup_at(dirname)
+        Dir.glob("#{dirname}/*_[0-9]*.md")
+      end
+  end
+end

data/lib/release_notes/cli.rb

@@ -2,20 +2,23 @@ require 'thor'
 require 'release_notes'
 require 'release_notes/version'
 require 'release_notes/versioning'
+require 'release_notes/cli/broadcast'
 require 'release_notes/cli/helpers'
 require 'release_notes/generators/release_note'
+require 'release_notes/generators/broadcast'
 
 module ReleaseNotes
   class CLI < Thor
-    
+    register(Broadcast, 'broadcast', 'broadcast [COMMAND]', 'Create a new broadcast or update Broadcast models')
+
     package_name 'ReleaseNotes'
     map '-v' => :version
 
 
-    desc 'new', 'create a new release note'
+    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 :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'
 
@@ -34,13 +37,13 @@ module ReleaseNotes
       end
 
       ReleaseNotes::Generators::ReleaseNote.start([options[:destination],
-                                             message,
-                                             update_version,
-                                             "--force=#{options[:force] || false}"])
+                                                   message,
+                                                   update_version,
+                                                   "--force=#{options[:force] || false}"])
     end
 
 
-    desc 'update', "update #{ReleaseNotes.release_note_model} model"
+    desc 'update', "Update #{ReleaseNotes.release_note_model} models"
     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'
@@ -108,7 +111,7 @@ module ReleaseNotes
     end
 
 
-    desc 'version', 'show version of release_notes'
+    desc 'version', 'Show version of release_notes'
 
     def version
       puts "ReleaseNotes #{ReleaseNotes::VERSION}"

data/lib/release_notes/engine.rb

@@ -1,5 +1,11 @@
 module ReleaseNotes
   class Engine < ::Rails::Engine
     isolate_namespace ReleaseNotes
+
+    initializer 'release_notes.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper ReleaseNotes::ApplicationHelper
+      end
+    end
   end
 end

data/lib/release_notes/generators/broadcast.rb

@@ -0,0 +1,52 @@
+require 'thor/group'
+
+module ReleaseNotes
+  module Generators
+    class Broadcast < Thor::Group
+      include Thor::Actions
+
+      argument :destination, :type => :string
+      argument :subject, :type => :string
+      argument :body, :type => :string
+      argument :release_note_version, :type => :string
+
+      source_root File.expand_path('../../../generators/templates', __FILE__)
+
+      def set_local_assigns
+        @subject = subject
+        @body = body
+        @release_note_version = release_note_version.gsub('.', '_')
+        @broadcast_template = 'broadcast_blank.md'
+        @destination = File.expand_path(destination)
+      end
+
+      def create_directory
+        empty_directory(@destination)
+      end
+
+      def get_broadcast_number
+        @broadcast_number = next_broadcast_number(@destination)
+      end
+
+      def copy_broadcast
+        @filename = "#{destination}/broadcast_#{@broadcast_number}.md"
+        template(@broadcast_template, @filename)
+      end
+
+      protected
+        def next_broadcast_number(dirname)
+          current_broadcast_number(dirname) + 1
+        end
+
+        def current_broadcast_number(dirname)
+          broadcast_lookup_at(dirname).collect do |file|
+            File.basename(file).split('_').last.to_i
+          end.max.to_i
+        end
+
+        def broadcast_lookup_at(dirname)
+          Dir.glob("#{dirname}/*_[0-9]*.md")
+        end
+    end
+  end
+end

data/lib/release_notes/generators/release_note.rb

@@ -28,7 +28,7 @@ module ReleaseNotes
         end
       end
 
-      def create_update_file
+      def create_directory
         empty_directory(@destination)
       end
 

data/lib/release_notes/version.rb

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

data/lib/release_notes.rb

@@ -13,10 +13,18 @@ module ReleaseNotes
   mattr_accessor :release_note_model
   @@release_note_model = 'ReleaseNote'
 
+  # Model name of the model created to store broadcasts.
+  mattr_accessor :broadcast_model
+  @@broadcast_model = 'Broadcast'
+
   # Name of the folder where release notes are stored.
   mattr_accessor :release_note_folder
   @@release_note_folder = 'release_notes'
 
+  # Path that ReleaseNotes::Engine is mounted at in the config/routes.rb file.
+  mattr_accessor :mount_at
+  @@mount_at = '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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release_notes
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Brandon Robins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,26 +145,33 @@ 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/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/broadcasts_generator.rb
 - lib/generators/active_record/release_notes_generator.rb
-- lib/generators/active_record/templates/migration.rb
+- lib/generators/active_record/templates/broadcasts_migration.rb
+- lib/generators/active_record/templates/release_notes_migration.rb
+- lib/generators/release_notes/broadcasts_generator.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/broadcast_blank.md
 - 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/broadcast.rb
 - lib/release_notes/cli/helpers.rb
 - lib/release_notes/engine.rb
+- lib/release_notes/generators/broadcast.rb
 - lib/release_notes/generators/release_note.rb
 - lib/release_notes/version.rb
 - lib/release_notes/versioning.rb