release_notes 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 731dcb71f1a19814625ea48da3cfd1fa952a9c0e
-  data.tar.gz: 6f51fcd0ea61d46157b59cc2a7adebde72002921
+  metadata.gz: d4b4a4e8bf933a1dfd39666d985d945b745ac7d7
+  data.tar.gz: 42b99ef88c751918ff5e18c1dd69e78f76fb5be5
 SHA512:
-  metadata.gz: c0ad76f89c32fa8f47fdd59de3ddf16127d785bce48399311e6a9564897e023acb00a6ca2ad7c7587321b1b3fd64257380ab4471f40cbd2ce4662bc26dbdeef5
-  data.tar.gz: 232cb6697d9e10cc1e84bb2fbd96906747217a44432f6473f3d70c8d39f507707748c1f5b8f5581a1fea5280a1c8bdd287823a8a38486dbbf0ef86ff878bfdfb
+  metadata.gz: 791430ac706055a30a97808aead68464764a50f644003a2f14447138324e1fd58d2d10378dfb971ea430ce2b38ff4b2463398a4cf38266c651f84866f4e667c7
+  data.tar.gz: 3c2f58bb077552783015e5822d8bd2fe33dc8244f1497e743a97b5acd187008bef7fe268152033b3d5439d13176160bd1673fa58c4e5ed255cba3883768cc441

data/.gitignore

@@ -12,8 +12,13 @@ doc/
 lib/bundler/man
 pkg
 rdoc
-release_notes/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
 spec/reports
+stamp
 test/tmp
 test/version_tmp
 tmp

data/.rspec

@@ -1,2 +1,3 @@
 --color
+--require spec_helper
 --format progress

data/README.md

@@ -22,7 +22,7 @@ If you're looking to use ReleaseNotes with Rails you will need to run the instal
 
     $ rails generate release_notes:install
 
-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:
+The generator will install a ReleaseNotes initializer containing various configuration options. When you are done, you are ready to add a ReleaseNote model to using the following generator:
 
     $ rails generate release_notes ReleaseNote
 
@@ -66,6 +66,28 @@ To get additional help on release_notes commands or to see all available options
 
     $ release_notes --help [command]
 
+### Rake Tasks
+
+You can also run the `release_notes new`, `release_notes update`, and `release_notes update -r` commands using the following rake tasks from within the project:
+
+#### release_notes new
+
+    $ rake release_notes:new
+    
+#### release_notes update
+
+    $ rake release_notes:update
+
+#### release_notes update -r
+
+    $ rake release_notes:rebuild
+
+### Show the latest ReleaseNote version
+
+To access a link to the latest release note just include the following snippet into your view:
+
+    <%= release_note_indicator %>
+
 ### 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`).

data/app/assets/javascripts/release_notes/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_self
+//= require bootstrap
+//= require_tree .

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

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

data/app/helpers/release_notes/application_helper.rb

@@ -24,5 +24,11 @@ module ReleaseNotes
 
       mark.render(markdown)
     end
+
+    def release_note_indicator
+      latest = ReleaseNotes.release_note_model.constantize.last
+      
+      link_to "#{ReleaseNotes.app_name} v#{latest.version}", release_notes.version_path(:version => latest.version.gsub('.','_')), 'data-no-turbolink' => true unless latest.nil?
+    end
   end
 end

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

@@ -5,7 +5,7 @@
     <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" %>
+    <%= javascript_include_tag "release_notes/application" %>
     <%= csrf_meta_tags %>
     <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
     <!--[if lt IE 9]>

data/config/routes.rb

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

data/lib/generators/release_notes/install_generator.rb

@@ -13,10 +13,6 @@ 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/release_notes.rb

@@ -6,9 +6,6 @@ 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 users.
-  config.user_model = 'User'
-
   # Name of the folder you're using to store the release note markdown files.
   config.release_note_folder = 'release_notes'
 

data/lib/release_notes/cli.rb

@@ -77,7 +77,7 @@ module ReleaseNotes
 
       # Collects relevant files and saves version and content to db
       update_files = collect_update_files(options[:destination])
-      update_files.reverse! if options[:reset]
+      update_files.reverse if options[:reset]
       
       update_files.each do |file|
         timestamp = file[0].to_i

data/lib/release_notes/engine.rb

@@ -1,11 +1,16 @@
 module ReleaseNotes
   class Engine < ::Rails::Engine
+    require 'bootstrap-sass'
+    
     isolate_namespace ReleaseNotes
 
-    config.to_prepare do
-      Dir.glob(Rails.root + "app/decorators/**/release_notes/*_decorator*.rb").each do |c|
-        require_dependency(c)
-      end
+    config.generators do |g|
+      g.test_framework        :rspec
+      g.fixture_replacement   :factory_girl, :dir => 'spec/factories'
+    end
+
+    rake_tasks do
+      load '../../tasks/release_notes.rake'
     end
 
     initializer 'release_notes.action_controller' do |app|

data/lib/release_notes/version.rb

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

data/lib/release_notes.rb

@@ -13,10 +13,6 @@ module ReleaseNotes
   mattr_accessor :release_note_model
   @@release_note_model = 'ReleaseNote'
 
-  # Model name of the model created to store users.
-  mattr_accessor :user_model
-  @@user_model = 'User'
-
   # Name of the folder where release notes are stored.
   mattr_accessor :release_note_folder
   @@release_note_folder = 'release_notes'

data/release_notes.gemspec

@@ -19,13 +19,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.1.1"
-  spec.add_development_dependency "rspec", "~> 2.14"
-  spec.add_development_dependency "cucumber", "~> 1.3.10"
-  spec.add_development_dependency "aruba", "~> 0.5.4"
-
+  spec.add_dependency "rails", ">= 3.2"
   spec.add_dependency "thor", ">= 0.18.1"
-  spec.add_dependency "rails", "> 3.0.0"
+  spec.add_dependency "sass-rails"
+  spec.add_dependency "bootstrap-sass", "~> 3.2.0"
   spec.add_dependency "redcarpet", "~> 3.0.0"
+
+  spec.add_development_dependency "rspec-rails", "~> 3.0.0"
+  spec.add_development_dependency "factory_girl_rails", "~> 4.4.1"
+  spec.add_development_dependency "sqlite3"
 end

data/spec/controllers/release_notes/release_notes_controller_spec.rb

@@ -0,0 +1,55 @@
+require 'rails_helper'
+
+module ReleaseNotes
+  RSpec.describe ReleaseNotesController, :type => :controller do
+
+    describe "#index" do
+      it "responds with an HTTP 200 status code" do
+        get :index, { use_route: :release_notes }
+
+        expect(response).to be_success
+        expect(response.status).to eq(200)
+      end
+
+      it "renders 'index' html template" do
+        get :index, { use_route: :release_notes }
+
+        expect(response).to render_template(:index)
+      end
+
+      it "assigns @release_notes" do
+        @release_notes = FactoryGirl.create_list(:release_note, 3)
+
+        get :index, { use_route: :release_notes }
+
+        expect(assigns(:release_notes).count).to eq(3)
+        expect(assigns(:release_notes)).to eq(@release_notes.reverse)
+      end
+    end
+
+    describe "#show" do
+      before(:each) do
+        @release_note = FactoryGirl.create(:release_note)
+      end
+
+      it "responds with an HTTP 200 status code" do
+        get :show, { version: @release_note.version, use_route: :release_notes }
+
+        expect(response).to be_success
+        expect(response.status).to eq(200)
+      end
+
+      it "renders 'show' html template" do
+        get :show, { version: @release_note.version, use_route: :release_notes }
+
+        expect(response).to render_template(:show)
+      end
+
+      it "assigns @release_notes" do
+        get :show, { version: @release_note.version, use_route: :release_notes }
+
+        expect(assigns(:release_notes)).to eq(@release_note)
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/release_note.rb

@@ -0,0 +1,3 @@
+class ReleaseNote < ActiveRecord::Base
+  validates :version, presence: true, uniqueness: true
+end

data/spec/dummy/app/views/home/index.html.erb

@@ -0,0 +1,17 @@
+<h1>
+  Release Notes Dummy App
+</h1>
+
+<p>
+  This is just a simple app created to demo and test ReleaseNotes. It's nothing fancy, but it gets the job done.
+</p>
+
+<p>
+  Run <strong><em>../../bin/release_notes update</em></strong> to add ReleaseNotes into Dummy app database.
+</p>
+
+<p>
+  To see ReleaseNotes for this Dummy app, <%= link_to "click here", release_notes_path %>.
+</p>
+
+<%= release_note_indicator %>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/spring

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# This file loads spring without using Bundler, in order to be fast
+# It gets overwritten when you run the `spring binstub` command
+
+unless defined?(Spring)
+  require "rubygems"
+  require "bundler"
+
+  if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    spring \((.*?)\)$.*?^$/m)
+    ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
+    ENV["GEM_HOME"] = ""
+    Gem.paths = ENV
+
+    gem "spring", match[1]
+    require "spring/binstub"
+  end
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "release_notes"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,82 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # `config.assets.precompile` has moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end