release_notes 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d57288609fb0fa2b5ecebcb9297f0c1325f8d19
-  data.tar.gz: e66df67f8015fc2c5e846f4075b880ede26fca3c
+  metadata.gz: 731dcb71f1a19814625ea48da3cfd1fa952a9c0e
+  data.tar.gz: 6f51fcd0ea61d46157b59cc2a7adebde72002921
 SHA512:
-  metadata.gz: 2afed717fe251763b46d0d2e91759e593441233362e29951054607ed63852dbbcb2eb0b7ee1beade18c103a0d8bdead0e5c993504e34fc51117acba48e6349e8
-  data.tar.gz: 154cbf62a72617323b680f1e88abddc001ed2555b56245314402484afc890bfd1f6737536a9a784cd791347a498d0680b215e09bda7adce910528ebbcfc87b23
+  metadata.gz: c0ad76f89c32fa8f47fdd59de3ddf16127d785bce48399311e6a9564897e023acb00a6ca2ad7c7587321b1b3fd64257380ab4471f40cbd2ce4662bc26dbdeef5
+  data.tar.gz: 232cb6697d9e10cc1e84bb2fbd96906747217a44432f6473f3d70c8d39f507707748c1f5b8f5581a1fea5280a1c8bdd287823a8a38486dbbf0ef86ff878bfdfb

data/README.md

@@ -32,45 +32,6 @@ Be sure to migrate your database.
 
     $ rake db:migrate
 
-### 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. 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
-
-Then add one of the following render tags to whichever view you'd like to display the broadcast message in.
-
-    <%= render 'release_notes/broadcasts/link_back' %>
-
-OR...
-
-    <%= render 'release_notes/broadcasts/bare' %>
-
-#### Views
-
-While not necessary, you may want to copy over the ReleaseNotes views to your app to customize:
-
-    $ 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
@@ -95,42 +56,19 @@ After finalizing your release note markdown file be sure to update your ReleaseN
 
     $ release_notes update
 
-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
-
-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.
-**Note:** You *can* use HTML within the markdown file.
-
-### Update Broadcast
+If you ever want to update a previous release note and/or want to rebuild your ReleaseNotes model and README you can run the following:
 
-After finalizing your broadcast markdown file be sure to update your Broadcast model by running:
+    $ release_notes update -r
 
-    $ release_notes broadcast update
+### Getting Help
 
-If you ever want to update a particular broadcast you can run the following:
+To get additional help on release_notes commands or to see all available options just run:
 
-    $ release_notes broadcast update -v=VERSION
+    $ release_notes --help [command]
 
-### 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
+### View release notes in your application
 
-The "latest" version will be set to the `VERSION` specified.
+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`).
 
 ## Contributing
 

data/lib/generators/release_notes/orm_helpers.rb

@@ -8,14 +8,6 @@ CONTENT
         buffer
       end
 
-      def broadcasts_model_contents
-        buffer = <<-CONTENT
-  validates :markdown, presence: true
-  validates :version, presence: true, uniqueness: true
-CONTENT
-        buffer
-      end
-
       private
 
         def model_exists?

data/lib/generators/templates/release_notes.rb

@@ -6,16 +6,10 @@ ReleaseNotes.setup do |config|
   # Name of the model you're using to store the various release notes.
   config.release_note_model = 'ReleaseNote'
 
-  # 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.
+  # Name of the folder you're using to store the release note markdown files.
   config.release_note_folder = 'release_notes'
 
   # Path that ReleaseNotes::Engine is mounted at in the config/routes.rb file.

data/lib/release_notes/cli.rb

@@ -2,15 +2,11 @@ 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
 
@@ -47,7 +43,6 @@ 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'
 
     def update
       # If reset option is passed delete all release notes in model

data/lib/release_notes/version.rb

@@ -1,3 +1,3 @@
 module ReleaseNotes
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/lib/release_notes.rb

@@ -13,18 +13,10 @@ 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'
-
   # 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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: release_notes
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Brandon Robins
@@ -145,35 +145,27 @@ 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/_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
 - 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/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/release_notes_controller_decorator.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

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

@@ -1,5 +0,0 @@
-<% if ReleaseNotes.broadcast_model.constantize.last %>
-  <div>
-    <%= markup(ReleaseNotes.broadcast_model.constantize.last.markdown).html_safe %>
-  </div>
-<% end %>

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

@@ -1,6 +0,0 @@
-<%= 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

@@ -1,47 +0,0 @@
-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}.rb"
-        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/templates/broadcasts_migration.rb

@@ -1,13 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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/templates/broadcast_blank.md

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

data/lib/release_notes/cli/broadcast.rb

@@ -1,116 +0,0 @@
-module ReleaseNotes
-  class Broadcast < Thor
-    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 :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],
-                                                 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 '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
-      if options[:reset]
-        ReleaseNotes.broadcast_model.constantize.all.each do |b|
-          b.destroy
-        end
-      end
-
-      if options[:version]
-        version = options[:version]
-        broadcast_file = single_broadcast_lookup_at(options[:destination], version)
-        markdown = File.read("#{options[:destination]}/#{broadcast_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
-      else
-        # 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)
-
-            say "#{ReleaseNotes.broadcast_model} version #{version} successfully saved.", :green
-          end
-        end
-      end
-    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}/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/generators/broadcast.rb

@@ -1,58 +0,0 @@
-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
-
-        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
-
-      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