change-log 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f90b7b9c038c413cacbe771d803c914012ae747
-  data.tar.gz: 6fced5cb988b66866d81b4050111b52773f5290b
+  metadata.gz: 5d28c518959559f38238447798ea9d4411b3d1ee
+  data.tar.gz: f058ea66fdbcbc6fe273146715e31d17c7272150
 SHA512:
-  metadata.gz: 31f31544b528c7cbac642bc4d94d77fa77ac8227d1b618cd7c4bb588b4ab2533730c190044c447f719c166be300a9e84f9d24c44495b36d94ce62af22edfcde9
-  data.tar.gz: 09d510fb2349e186ac8c11b2b8a70709746cfad29887d0b17ed25bda46cec64ac4ce16fdbc55a3d6c5460490f8d7cb70c77fa8b3c6f727164d55665746aae677
+  metadata.gz: ac27c2deba965ae351b17f41ef92aa680d6dd9d1a05162ba8966d7fd1437b7f0f51a8af02acb403fd80130630800f120b74f9adb70ab7aaf5abe091d05665dfe
+  data.tar.gz: 81ce28ae28a52c2cd8b1445aa4f4fecde3b63a58dbaba4a68586cebc876f5eecb0fe78d1788b6f021793c49cf1d5e061e489c9aa48ee0f5132d53e9b43ddaa04

data/README.md

@@ -0,0 +1,86 @@
+# ChangeLog
+
+ChangeLog is a Rails engine designed to facilitate parsing change log from git commit message and display in the browser.
+
+## Requirements
+
+ChangeLog is compatible with Rails  > 3.1
+
+ChangeLog works with `activerecord` and `mongoid`
+
+##Usage
+ChangeLog does not consider all the commit messages but with a special prefix. (`~~~` is default but you can override with other in the `change_log.rb` config file )
+
+You can tag your messages. Like you may have 3/4 tags in each build.
+
+If you commit with a message like this:
+```bash
+   ~~~VERSION_NUMBER(optional) # it will starts from 0.0.1 and path option will be increased if VERSION_NUMBER is not given
+   ~~feature # here feature is a tag
+    - feature one
+    - feature two
+    - feature three implemented
+
+   ~~bug
+    - bug 1 resolved
+    - bug 2 resolved
+    - bug 3 resolved
+
+   ~~api
+    + api foo implemented
+    + api bar modified
+```
+
+and run
+
+```ruby
+  rake change_log:update_log
+```
+You will have output like:
+
+##0.0.1 {TIME}
+<p>feature:</p>
+   - feature one
+   - feature two
+   - feature three implemented
+
+<p>bug:</p>
+   - bug 1 resolved
+   - bug 2 resolved
+   - bug 3 resolved
+
+<p>api:</p>
+   + api foo implemented
+   + api bar modified
+
+The commit message is markdown enabled
+## Installation & Setup
+
+To install add the following to your Gemfile:
+
+```ruby
+  gem 'change-log'
+```
+
+To setup just run:
+
+```bash
+  $ rake change_log:setup
+```
+
+and follow the guide !
+
+## Authentication
+
+If you want to authenticate users who can access ChangeLog, you need to provide <tt>ChangeLog::ApplicationController.authenticator</tt> proc. For example :
+
+```ruby
+  # config/initializers/change_log.rb
+  ChangeLog::ApplicationController.authenticator = proc {
+    authenticate_or_request_with_http_basic do |user_name, password|
+      user_name == 'change-log' && password == 'passme'
+    end
+  }
+```
+
+Authenticator proc will be run from a before filter in controller context.

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

@@ -11,5 +11,29 @@
 // GO AFTER THE REQUIRES BELOW.
 //
 //= require jquery.min
-//= require jquery_ujs
-//= require_tree .
+//= require_self
+
+(function ($) {
+    $(document).on('click', 'ul.tag-list input[type=checkbox]', function () {
+        $('.version-wrapper').show();
+
+        $('ul.tag-list input[type=checkbox]:not(:checked)').each(function () {
+            var tagDiv = $('.tag-start.' + $(this).val());
+            tagDiv.hide();
+
+        });
+
+        $('ul.tag-list input[type=checkbox]:checked').each(function () {
+            var tagDiv = $('.tag-start.' + $(this).val());
+            tagDiv.show();
+            if (tagDiv.parent('.version-wrapper').find('div.tag-start:visible').length > 0)
+                tagDiv.parent('.version-wrapper').show()
+        });
+
+        $('.version-wrapper').each(function () {
+            if ($(this).find('div.tag-start:visible').length <= 0)
+                $(this).hide()
+        });
+
+    })
+})(jQuery);

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

@@ -297,3 +297,13 @@
 .markdown-body pre code:before, .markdown-body pre code:after, .markdown-body pre tt:before, .markdown-body pre tt:after {
     content: normal;
 }
+
+.markdown-body ul.tag-list {
+    margin: 0;
+    padding: 0;
+    list-style-type: none;
+}
+.markdown-body ul.tag-list li{
+    display: inline;
+    padding: 7px 15px;
+}

data/app/controllers/change_log/application_controller.rb

@@ -1,5 +1,12 @@
-require 'rdiscount'
 module ChangeLog
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
+
+    cattr_accessor :authenticator
+
+    before_filter :authenticate_change_log
+
+    def authenticate_change_log
+      instance_exec(nil, &self.authenticator) if self.authenticator && self.authenticator.respond_to?(:instance_exec)
+    end
   end
 end

data/app/controllers/change_log/base_controller.rb

@@ -1,5 +1,5 @@
 module ChangeLog
-  class BaseController < ::ApplicationController
+  class BaseController < ChangeLog::ApplicationController
     layout ChangeLog.config.layout
 
     def index
@@ -8,9 +8,9 @@ module ChangeLog
 
     def _model
       if ChangeLog.config.orm == 'activerecord'
-        ChangeLog::ActiverecordModel
+        @change_log_model = ChangeLog::ActiverecordModel
       else
-        ChangeLog::MongoidModel
+        @change_log_model = ChangeLog::MongoidModel
       end
     end
   end

data/app/helpers/change_log/application_helper.rb

@@ -2,7 +2,7 @@ require 'kramdown'
 module ChangeLog
   module ApplicationHelper
     def md(string)
-      Kramdown::Document.new(string).to_html.html_safe
+      Kramdown::Document.new(string, parse_block_html: true).to_html.html_safe
     end
   end
 end

data/app/views/change_log/base/index.html.erb

@@ -1,5 +1,26 @@
-  <% @items.each do |item| %>
-      <h2> <%= item.version %> {<%= item.time %>}</h2>
-      <%= md item.message %>
-      <br/>
-  <% end %>
+<% cache @change_log_model.last_release do %>
+    <% if ChangeLog.config.tag_filter_enabled %>
+        <fieldset>
+          <legend>Tags:</legend>
+          <ul class="tag-list">
+            <% @items.collect(&:tags).join(',').split(',').uniq.each do |tag| %>
+                <li>
+                  <%= check_box_tag '_', tag, true %>  <%= tag %>
+                </li>
+            <% end %>
+          </ul>
+        </fieldset>
+    <% end %>
+
+    <% @items.each do |item| %>
+        <div class="version-wrapper">
+          <h2> <%= item.version %> {<%= l item.time.to_date %>}</h2>
+          <%= md item.message %>
+        </div>
+    <% end %>
+    <% if @items.count == 0 %>
+        Please run <code>rake change_log:update_log</code> to get change logs here. <br/>
+        For more information please visit: <a href="https://github.com/amuntasim/change-log">ChangeLog Wiki</a>
+
+    <% end %>
+<% end %>

data/lib/change-log.rb

@@ -0,0 +1 @@
+require "change_log"

data/lib/change_log/config.rb

@@ -2,7 +2,6 @@ require 'active_support/core_ext/class/attribute_accessors'
 
 module ChangeLog
   module Config
-
     class << self
       # Table prefix to avoid collision
       attr_accessor :table_prefix
@@ -17,11 +16,14 @@ module ChangeLog
 
       attr_accessor :tag_prefix
 
+      attr_accessor :tag_filter_enabled
+
       def reset
         @layout = 'change_log/application'
         @table_prefix = nil
         @commit_prefix = '~~~'
         @tag_prefix = '~~'
+        @tag_filter_enabled = true
       end
     end
 

data/lib/change_log/version.rb

@@ -1,3 +1,3 @@
 module ChangeLog
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/generators/change_log/install_generator.rb

@@ -32,7 +32,7 @@ module ChangeLog
         @table_prefix = ask_for("Do you want to add #{_table} prefix?", nil, table_prefix)
         template "initializer.erb", "config/initializers/change_log.rb"
       else
-        display "You already have a config file. You're updating, heh? I'm generating a new 'change_log.rb.example' that you can review."
+        display "You already have a config file. generating a new 'change_log.rb.example' that you can review."
         template "initializer.erb", "config/initializers/change_log.rb.example"
       end
 

data/lib/generators/change_log/templates/initializer.erb

@@ -23,12 +23,13 @@ ChangeLog.config do |config|
    #config.commit_prefix = '~~~'
 
    #config.tag_prefix = '~~'
+
+   #config.tag_filter_enabled = true
+
 end  if defined? ChangeLog
 
-<% if @table_prefix.present? %>
 <% if @orm == 'mongoid' -%>
 ChangeLog::MongoidModel.store_in collection: :'<%= [@table_prefix, 'change_logs'].compact.join('_') %>'
 <% else %>
 ChangeLog::ActiverecordModel.table_name = '<%= [@table_prefix, 'change_logs'].compact.join('_') %>'
 <% end -%>
-<% end %>

data/lib/generators/change_log/templates/migration.rb

@@ -1,16 +1,14 @@
-class CreateTolkTables < ActiveRecord::Migration
+class CreateChangeLogTables < ActiveRecord::Migration
   def self.up
     create_table :<%= [table_prefix, 'change_logs'].compact.join('_') %> do |t|
       t.string   :version, limit: 20
       t.datetime   :time
       t.string   :message, limit: 1000
       t.string   :author, limit: 50
+      t.string :tags, limit: 100
       t.datetime :created_at
       t.datetime :updated_at
     end
-
-    add_index :<%= [table_prefix, 'change_logs'].compact.join('_') %>, :category
-
   end
 
   def self.down

data/lib/tasks/change_log_tasks.rake

@@ -5,27 +5,26 @@ namespace :change_log do
   desc "Copying settings, models etc."
   task :setup => :environment do
     system 'rails g change_log:install'
+    Rake::Task['db:migrate'].invoke
   end
 
   desc "parse release notes and put into db"
   task :update_log , [:repo_path] => :environment do |t, args|
+    require 'git'
     repo_path = args.repo_path || Rails.root
-    repo = Rugged::Repository.new("#{repo_path}/.git/")
-    walker = Rugged::Walker.new(repo)
-    walker.push(repo.head.target_id)
-    walker.sorting(Rugged::SORT_DATE) # optional
+    repo = Git.open(repo_path)
     last_release = base_model.last_release
     if last_release
-      records = walker.select { |c| c.time > last_release.time && c.message =~ /#{ChangeLog.config.commit_prefix}/ }
+      records = repo.log.since(last_release.time).select { |c|  c.message =~ /#{ChangeLog.config.commit_prefix}/ }
     else
-      records = walker.select { |c| c.message =~ /#{ChangeLog.config.commit_prefix}/ }
+      records = repo.log.select { |c| c.message =~ /#{ChangeLog.config.commit_prefix}/ }
     end
     records.each do |record|
-      parse_ans_store_commit_message(record, last_release)
+      parse_and_store_commit_message(record, last_release)
     end
   end
 
-  def parse_ans_store_commit_message(record, last_release)
+  def parse_and_store_commit_message(record, last_release)
 #     messages = <<-eos
 # ###
 # ##api
@@ -46,18 +45,23 @@ namespace :change_log do
     formatted_message = []
     lines.each do |line|
       if tag = parse_tag(line)
+        formatted_message << "</div>"  if o_tag.any?
+        formatted_message << "<div class='tag-start #{tag}'>"
+
         o_tag << tag
-        formatted_message << "<p>#{tag}</p>"
+        formatted_message << "<p>#{tag}:</p>"
       else
         formatted_message << line
       end
     end
-    base_model.create(version: version, author: record.author, message: formatted_message.join(''), time: record.time, tags: o_tag.join(','))
+    formatted_message << "\n </div>"
+
+    base_model.create(version: version, author: record.author, message: formatted_message.join(''), time: record.date, tags: o_tag.join(','))
 #base_model.create(version: version, author: 'record.author', message: formatted_message.join(''), time: 'record.time', tags: o_tag.join(','))
   end
 
   def parse_tag(line)
-    line.gsub(ChangeLog.config.tag_prefix, '').strip if line =~ /#{ChangeLog.config.tag_prefix}/
+    line.gsub(/#{ChangeLog.config.tag_prefix}|\:/, '').strip if line =~ /#{ChangeLog.config.tag_prefix}/
   end
 
   def version_number(line)

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: change-log
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Muntasim Ahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rugged
+  name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 1.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 1.2.6
 - !ruby/object:Gem::Dependency
   name: orm_adapter
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - app/assets/javascripts/change_log/application.js
 - app/assets/stylesheets/change_log/application.css
@@ -107,6 +107,7 @@ files:
 - app/views/change_log/base/index.html.erb
 - app/views/layouts/change_log/application.html.erb
 - config/routes.rb
+- lib/change-log.rb
 - lib/change_log.rb
 - lib/change_log/config.rb
 - lib/change_log/engine.rb

data/README.rdoc

@@ -1,3 +0,0 @@
-= ChangeLog
-
-This project rocks and uses MIT-LICENSE.