release_notes 0.1.3

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

@@ -0,0 +1,161 @@
+
+
+.release {
+  background: #EEE;
+  border-radius: 3px;
+
+  .note {
+    background-color: #fff;
+    border: 1px solid #CACACA;
+    padding: 30px;
+  }
+}
+
+.markdown-body {
+  font-size: 15px;
+  line-height: 1.7;
+  overflow: hidden;
+  word-wrap: break-word;
+
+  >*:first-child {
+    margin-top: 0 !important;
+  }
+
+  >*:last-child {
+    margin-bottom: 0 !important;
+  }
+
+  h1 {
+    font-size: 2.5em;
+    border-bottom: 1px solid #ddd;
+  }
+
+  h2 {
+    font-size: 2em;
+    border-bottom: 1px solid #eee;
+  }
+
+  h3 {
+    font-size: 1.5em;
+  }
+
+  h4 {
+    font-size: 1.2em;
+  }
+
+  h5 {
+    font-size: 1em;
+  }
+
+  h6 {
+    color: #777;
+    font-size: 1em;
+  }
+
+  h1, h2, h3, h4, h5, h6 {
+    margin: 1em 0 15px;
+    padding: 0;
+    font-weight: bold;
+    line-height: 1.7;
+    cursor: text;
+    position: relative;
+
+    .octicon-link {
+      display: none;
+      color: #000;
+    }
+  }
+
+  p, blockquote, ul, ol, dl, table, pre {
+    margin: 15px 0;
+  }
+
+  ol {
+    padding-left: 30px;
+  }
+
+  a.anchor {
+    display: block;
+    padding-right: 6px;
+    padding-left: 30px;
+    margin-left: -30px;
+    cursor: pointer;
+    position: absolute;
+    top: 0;
+    left: 0;
+    bottom: 0;
+  }
+
+  pre {
+    word-wrap: normal;
+  }
+
+  pre code, pre tt {
+    margin: 0;
+    padding: 0;
+    background-color: transparent;
+    border: none;
+    word-wrap: normal;
+  }
+
+  pre>code {
+    margin: 0;
+    padding: 0;
+    white-space: pre;
+    border: none;
+    background: transparent;
+  }
+
+  code {
+    white-space: nowrap;
+  }
+
+  code, tt {
+    margin: 0 2px;
+    padding: 0px 5px;
+    border: 1px solid #ddd;
+    background-color: #f8f8f8;
+    border-radius: 3px;
+  }
+
+  .highlight pre, pre {
+    background-color: #f8f8f8;
+    border: 1px solid #ddd;
+    font-size: 13px;
+    line-height: 19px;
+    overflow: auto;
+    padding: 6px 10px;
+    border-radius: 3px;
+  }
+
+  table {
+    width: 100%;
+    overflow: auto;
+    display: block;
+
+    tr {
+      border-top: 1px solid #ccc;
+      background-color: #fff;
+    }
+
+    tr:nth-child(2n) {
+      background-color: #f8f8f8;
+    }
+
+    th, td {
+      border: 1px solid #ddd;
+      padding: 6px 13px;
+    }
+  }
+
+  tt, code, pre {
+    font-family: Consolas, "Liberation Mono", Courier, monospace;
+    font-size: 12px;
+    color: #333333;
+  }
+}
+
+code, kbd, pre, samp {
+  font-family: monospace, serif;
+  font-size: 1em;
+}

data/app/controllers/release_notes/application_controller.rb

@@ -0,0 +1,2 @@
+class ReleaseNotes::ApplicationController < ApplicationController
+end

data/app/controllers/release_notes/release_notes_controller.rb

@@ -0,0 +1,11 @@
+module ReleaseNotes
+  class ReleaseNotesController < ApplicationController
+    def index
+      @release_notes = "::#{ReleaseNotes.release_note_model}".constantize.all.order('-id')
+    end
+
+    def show
+      @release_notes = "::#{ReleaseNotes.release_note_model}".constantize.where(version: "#{params[:version]}".gsub('_','.'))
+    end
+  end
+end

data/app/helpers/release_notes/application_helper.rb

@@ -0,0 +1,28 @@
+module ReleaseNotes
+  module ApplicationHelper
+    require 'redcarpet'
+    
+    def markup(markdown)
+      extension_options = [:no_intra_emphasis => true,
+                           :tables => true,
+                           :fenced_code_blocks => true,
+                           :autolink => true,
+                           :strikethrough => true,
+                           :space_after_headers => true,
+                           :superscript => true,
+                           :underline => true,
+                           :highlight => true,
+                           :quote => true,
+                           :footnotes => true]
+
+      render_options = [:filter_html => true,
+                        :hard_wrap => true,
+                        :prettify => true]
+
+      renderer = Redcarpet::Render::HTML.new(*render_options)
+      mark = Redcarpet::Markdown.new(renderer, *extension_options)
+
+      mark.render(markdown)
+    end
+  end
+end

data/app/views/layouts/release_notes/application.html.erb

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%= ReleaseNotes.app_name %> Release Notes</title>
+    <%= stylesheet_link_tag "release_notes/application", media: "all" %>
+    <%= javascript_include_tag "release_notes/bootstrap" %>
+    <%= csrf_meta_tags %>
+    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+      <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+      <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div id="wrap">
+      <div class="container">
+        <div class="header">
+          <ul class="nav nav-pills pull-right">
+            <li><%= link_to "#{ReleaseNotes.app_name}", '/' %></li>
+            <li <% if params[:action] == 'index' %>class="active"<% end %>><a href="/<%= ReleaseNotes.release_note_folder %>">Release Notes</a></li>
+          </ul>
+          <h3 class="text-muted"><%= ReleaseNotes.app_name %></h3>
+        </div>
+        <%= yield %>
+      </div>
+    </div>
+    <footer class="footer">
+      <div class="container">
+        <p class="text-muted center">
+          Creating using <a href="http://www.github.com/eanlain/release_notes" target="_blank">ReleaseNotes</a>.
+        </p>
+        <p class="center">
+          <a href="#">Back to top</a>
+        </p>
+      </div>
+    </footer>
+  </body>
+</html>

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

@@ -0,0 +1,11 @@
+<% @release_notes.each do |rn| %>
+  <div class="release">
+    <div class="row note">
+      <div class="col-sm-12">
+        <div class="markdown-body">
+          <%= markup(rn.markdown).html_safe %>
+        </div>
+      </div>
+    </div>
+  </div>
+<% end %>

data/app/views/release_notes/release_notes/index.html.erb

@@ -0,0 +1 @@
+<%= render 'shared' %>

data/app/views/release_notes/release_notes/show.html.erb

@@ -0,0 +1 @@
+<%= render 'shared' %>

data/bin/release_notes

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+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."
+end
+
+require 'release_notes/cli'
+ReleaseNotes::CLI.start

data/config/routes.rb

@@ -0,0 +1,4 @@
+ReleaseNotes::Engine.routes.draw do
+  get '/' => 'release_notes#index'
+  get '/:version' => 'release_notes#show'
+end

data/features/support/setup.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/generators/active_record/release_notes_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/active_record'
+require 'generators/release_notes/orm_helpers'
+
+module ActiveRecord
+  module Generators
+    class ReleaseNotesGenerator < 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_release_notes_migration
+        if (behavior == :invoke && model_exists?)
+          raise "#{table_name} already exists..."
+        else
+          migration_template "migration.rb", "db/migrate/release_notes_create_#{table_name}"
+        end
+      end
+
+      def generate_model
+        invoke "active_record:model", [name], :migration => false unless model_exists? && behavior == :invoke
+      end
+
+      def inject_release_notes_content
+        content = 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/migration.rb

@@ -0,0 +1,15 @@
+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
+
+    add_index :<%= table_name %>, :version, :unique => true
+  end
+end

data/lib/generators/release_notes/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators/base'
+
+module ReleaseNotes
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a ReleaseNotes initializer for your application."
+
+      class_option :orm
+
+      def copy_initializer
+        template "release_notes.rb", "config/initializers/release_notes.rb"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/release_notes/orm_helpers.rb

@@ -0,0 +1,27 @@
+module ReleaseNotes
+  module Generators
+    module OrmHelpers
+      def model_contents
+        buffer = <<-CONTENT
+  validates :version, presence: true,
+                      uniqueness: true
+CONTENT
+        buffer
+      end
+
+      private
+
+        def model_exists?
+          File.exists?(File.join(destination_root, model_path))
+        end
+        
+        def migration_path
+          @migration_path ||= File.join("db", "migrate")
+        end
+
+        def model_path
+          @model_path ||= File.join("app", "models", "#{file_path}.rb")
+        end
+    end
+  end
+end

data/lib/generators/release_notes/release_notes_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/named_base'
+
+module ReleaseNotes
+  module Generators
+    class ReleaseNotesGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      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."
+
+      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}'"
+
+        route release_notes_routes
+      end
+    end
+  end
+end

data/lib/generators/release_notes/views_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/base'
+
+module ReleaseNotes
+  module Generators
+    module ViewPathTemplates
+      extend ActiveSupport::Concern
+
+      included do
+        argument :scope, :required => false, :default => nil,
+                         :desc => "The scope to copy views to"
+
+        public_task :copy_views
+      end
+
+      module ClassMethods
+        def hide!
+          Rails::Generators.hide_namespace self.namespace
+        end
+      end
+
+      protected
+        def view_directory(name, _target_path=nil)
+          directory name.to_s, _target_path || "#{target_path}/#{name}" do |content|
+            content
+          end
+        end
+
+        def target_path
+          @target_path ||= "app/views/#{scope || :release_notes}"
+        end
+    end
+
+    class ViewsGenerator < Rails::Generators::Base
+      include ViewPathTemplates
+      source_root File.expand_path("../../../../app/views/release_notes/", __FILE__)
+
+      desc "Copies ReleaseNotes views to your application."
+
+      argument :scope, :required => false, :default => nil,
+                       :desc => "The scope to copy views to"
+
+      def copy_views
+        view_directory :release_notes
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,20 @@
+======================================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Check/update ReleaseNote initializer file (config/initializers/release_notes.rb).
+      At a minimum you may want to update the app_name... or not...
+
+  2. Create a ReleaseNote model by running:
+
+      rails g release_notes ReleaseNote
+
+  3. Migrate your newly created ReleaseNote model:
+
+      rake db:migrate
+
+  4. You can copy ReleaseNotes views (for customization) to your app by running:
+
+       rails g release_notes:views
+
+======================================================================================

data/lib/generators/templates/release_notes.rb

@@ -0,0 +1,14 @@
+# Use this hook to configure ReleaseNotes.
+ReleaseNotes.setup do |config|
+  # The 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.
+  config.release_note_model = 'ReleaseNote'
+
+  # The name of the folder you're using to store the release note markdown files.
+  config.release_note_folder = 'release_notes'
+
+  # The version number that the first ReleaseNote should start at.
+  config.starting_version = '0.1.0'
+end

data/lib/generators/templates/update.md

@@ -0,0 +1,72 @@
+# <%= @app_name -%> <%= @release_version.gsub('_', '.') -%> Release Notes
+<% if @message['overview'].length > 0 -%>
+###### <%= @message['overview'] -%>
+
+<% end -%>
+
+#### <%= Time.now.utc.strftime('%m/%d/%Y') %>
+
+<% if !@message['additions'].empty? -%>
+Additions
+----
+<% @message['additions'].each do |msg| -%>
+* <%= msg -%>
+
+<% end -%>
+<% end -%>
+
+<% if !@message['changes'].empty? -%>
+Changes
+----
+<% @message['changes'].each do |msg| -%>
+* <%= msg -%>
+
+<% end -%>
+<% end -%>
+
+<% if !@message['improvements'].empty? -%>
+Improvements
+----
+<% @message['improvements'].each do |msg| -%>
+* <%= msg -%>
+
+<% end -%>
+<% end -%>
+
+<% if !@message['removals'].empty? -%>
+Removals
+----
+<% @message['removals'].each do |msg| -%>
+* <%= msg -%>
+
+<% end -%>
+<% end -%>
+
+<% if !@message['fixes'].empty? -%>
+Fixes
+----
+<% @message['fixes'].each do |msg| -%>
+* <%= msg -%>
+
+<% end -%>
+<% end -%>
+
+<% if !@message['bugs'].empty? -%>
+Known Issues / Bugs
+----
+<% @message['bugs'].each do |msg| -%>
+* <%= msg -%>
+
+<% end -%>
+<% end -%>
+
+<% if !@message['upcoming'].empty? -%>
+Upcoming
+----
+<% @message['upcoming'].each do |msg| -%>
+* <%= msg -%>
+
+<% end -%>
+<% end -%>
+
+*the end*

data/lib/generators/templates/update_blank.md

@@ -0,0 +1,41 @@
+# <%= @app_name -%> <%= @release_version.gsub('_', '.') -%> Release Notes
+###### A one (or two) sentence overview blurb of this release.
+
+#### <%= Time.now.utc.strftime('%m/%d/%Y') %>
+
+Additions
+----
+* <em>Any new additions to the app go here.</em>
+
+
+Changes
+----
+* <em>Any notable changes should be covered here.</em>
+
+
+Improvements
+----
+* <em>Not a bad idea to highlight some improvements.</em>
+
+
+Removals
+----
+* <em>Something missing? ...probably should list it here.</em>
+
+
+Fixes
+----
+* <em>Things that were fixed since the last release.</em>
+
+
+Known Issues / Bugs
+----
+* <em>If any bugs are present let them be known.</em>
+
+
+Upcoming
+----
+* <em>What's in the release pipeline?</em>
+
+
+*the end*

data/lib/release_notes/cli/helpers.rb

@@ -0,0 +1,64 @@
+module ReleaseNotes
+  class CLI < Thor
+    class Helpers
+      class << self
+        include Thor::Shell
+
+        def setup_message_obj
+          message = {}
+          message['overview'] = ""
+          message['additions'] = []
+          message['changes'] = []
+          message['improvements'] = []
+          message['removals'] = []
+          message['fixes'] = []
+          message['bugs'] = []
+          message['upcoming'] = []
+          message
+        end
+
+        def interactive_bullets(message)
+          say "Enter in the letter type of bullet followed by the bullet's text (i.e. 'a: This is a simple addition bullet')", :yellow
+          say "Bullet types are as follows => (a)dditions, (c)hanges, (i)mprovements, (r)emovals, (f)ixes, (b)ugs/Known Issues, (u)pcoming", :yellow
+          say "When you are finished type 'done' to finish.", :cyan
+          
+          loop do
+            input = ask('a/c/i/r/f/b/u: Bullet', :green)
+
+            if input == 'done' or input == "'done'"
+              break
+            elsif input == 'cancel' or input == "'cancel'"
+              return false          
+            elsif input[0..2] == 'a: '
+              message['additions'].push input[3..input.length]
+              say "Addition bullet added."
+            elsif input[0..2] == 'c: '
+              message['changes'].push input[3..input.length]
+              say "Changes bullet added."
+            elsif input[0..2] == 'i: '
+              message['improvements'].push input[3..input.length]
+              say "Improvements bullet added."
+            elsif input[0..2] == 'r: '
+              message['removals'].push input[3..input.length]
+              say "Removals bullet added."
+            elsif input[0..2] == 'f: '
+              message['fixes'].push input[3..input.length]
+              say "Fixes bullet added."
+            elsif input[0..2] == 'b: '
+              message['bugs'].push input[3..input.length]
+              say "Bugs/Known Issues bullet added."
+            elsif input[0..2] == 'u: '
+              message['upcoming'].push input[3..input.length]
+              say "Upcoming bullet added."
+            else
+              say "Invalid format. Please try that last one again...", :red
+            end
+          end
+
+          message['overview'] = ask "Please give a one (or two) sentence overview of this release... or just be unhelpful and press ENTER.", :yellow
+          message
+        end
+      end
+    end
+  end
+end