change-log 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f90b7b9c038c413cacbe771d803c914012ae747
+  data.tar.gz: 6fced5cb988b66866d81b4050111b52773f5290b
+SHA512:
+  metadata.gz: 31f31544b528c7cbac642bc4d94d77fa77ac8227d1b618cd7c4bb588b4ab2533730c190044c447f719c166be300a9e84f9d24c44495b36d94ce62af22edfcde9
+  data.tar.gz: 09d510fb2349e186ac8c11b2b8a70709746cfad29887d0b17ed25bda46cec64ac4ce16fdbc55a3d6c5460490f8d7cb70c77fa8b3c6f727164d55665746aae677

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

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

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ChangeLog'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/change_log/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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery.min
+//= require jquery_ujs
+//= require_tree .

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

@@ -0,0 +1,299 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree
+ */
+
+.markdown-body {
+    font-family: "Helvetica Neue",Helvetica,"Segoe UI",Arial,freesans,sans-serif;
+    font-size: 16px;
+    line-height: 1.6;
+    overflow: hidden;
+    word-wrap: break-word;
+}
+.markdown-body > *:first-child {
+    margin-top: 0 !important;
+}
+.markdown-body > *:last-child {
+    margin-bottom: 0 !important;
+}
+.markdown-body .absent {
+    color: #c00;
+}
+.markdown-body .anchor {
+    bottom: 0;
+    display: block;
+    left: 0;
+    margin-left: -30px;
+    padding-left: 30px;
+    padding-right: 6px;
+    position: absolute;
+    top: 0;
+}
+.markdown-body .anchor:focus {
+    outline: medium none;
+}
+.markdown-body h1, .markdown-body h2, .markdown-body h3, .markdown-body h4, .markdown-body h5, .markdown-body h6 {
+    font-weight: bold;
+    line-height: 1.4;
+    margin-bottom: 16px;
+    margin-top: 1em;
+    position: relative;
+}
+.markdown-body h1 .octicon-link, .markdown-body h2 .octicon-link, .markdown-body h3 .octicon-link, .markdown-body h4 .octicon-link, .markdown-body h5 .octicon-link, .markdown-body h6 .octicon-link {
+    color: #000;
+    display: none;
+    vertical-align: middle;
+}
+.markdown-body h1:hover .anchor, .markdown-body h2:hover .anchor, .markdown-body h3:hover .anchor, .markdown-body h4:hover .anchor, .markdown-body h5:hover .anchor, .markdown-body h6:hover .anchor {
+    line-height: 1;
+    margin-left: -30px;
+    padding-left: 8px;
+    text-decoration: none;
+}
+.markdown-body h1:hover .anchor .octicon-link, .markdown-body h2:hover .anchor .octicon-link, .markdown-body h3:hover .anchor .octicon-link, .markdown-body h4:hover .anchor .octicon-link, .markdown-body h5:hover .anchor .octicon-link, .markdown-body h6:hover .anchor .octicon-link {
+    display: inline-block;
+}
+.markdown-body h1 tt, .markdown-body h1 code, .markdown-body h2 tt, .markdown-body h2 code, .markdown-body h3 tt, .markdown-body h3 code, .markdown-body h4 tt, .markdown-body h4 code, .markdown-body h5 tt, .markdown-body h5 code, .markdown-body h6 tt, .markdown-body h6 code {
+    font-size: inherit;
+}
+.markdown-body h1 {
+    border-bottom: 1px solid #eee;
+    font-size: 2.25em;
+    line-height: 1.2;
+    padding-bottom: 0.3em;
+}
+.markdown-body h2 {
+    border-bottom: 1px solid #eee;
+    font-size: 1.75em;
+    line-height: 1.225;
+    padding-bottom: 0.3em;
+}
+.markdown-body h3 {
+    font-size: 1.5em;
+    line-height: 1.43;
+}
+.markdown-body h4 {
+    font-size: 1.25em;
+}
+.markdown-body h5 {
+    font-size: 1em;
+}
+.markdown-body h6 {
+    color: #777;
+    font-size: 1em;
+}
+.markdown-body p, .markdown-body blockquote, .markdown-body ul, .markdown-body ol, .markdown-body dl, .markdown-body table, .markdown-body pre {
+    margin-bottom: 16px;
+    margin-top: 0;
+}
+.markdown-body hr {
+    background-color: #e7e7e7;
+    border: 0 none;
+    height: 4px;
+    margin: 16px 0;
+    padding: 0;
+}
+.markdown-body ul, .markdown-body ol {
+    padding-left: 2em;
+}
+.markdown-body ul.no-list, .markdown-body ol.no-list {
+    list-style-type: none;
+    padding: 0;
+}
+.markdown-body ul ul, .markdown-body ul ol, .markdown-body ol ol, .markdown-body ol ul {
+    margin-bottom: 0;
+    margin-top: 0;
+}
+.markdown-body li > p {
+    margin-top: 16px;
+}
+.markdown-body dl {
+    padding: 0;
+}
+.markdown-body dl dt {
+    font-size: 1em;
+    font-style: italic;
+    font-weight: bold;
+    margin-top: 16px;
+    padding: 0;
+}
+.markdown-body dl dd {
+    margin-bottom: 16px;
+    padding: 0 16px;
+}
+.markdown-body blockquote {
+    border-left: 4px solid #ddd;
+    color: #777;
+    padding: 0 15px;
+}
+.markdown-body blockquote > *:first-child {
+    margin-top: 0;
+}
+.markdown-body blockquote > *:last-child {
+    margin-bottom: 0;
+}
+.markdown-body table {
+    display: block;
+    overflow: auto;
+    width: 100%;
+    word-break: keep-all;
+}
+.markdown-body table th {
+    font-weight: bold;
+}
+.markdown-body table th, .markdown-body table td {
+    border: 1px solid #ddd;
+    padding: 6px 13px;
+}
+.markdown-body table tr {
+    background-color: #fff;
+    border-top: 1px solid #ccc;
+}
+.markdown-body table tr:nth-child(2n) {
+    background-color: #f8f8f8;
+}
+.markdown-body img {
+    box-sizing: border-box;
+    max-width: 100%;
+}
+.markdown-body span.frame {
+    display: block;
+    overflow: hidden;
+}
+.markdown-body span.frame > span {
+    border: 1px solid #ddd;
+    display: block;
+    float: left;
+    margin: 13px 0 0;
+    overflow: hidden;
+    padding: 7px;
+    width: auto;
+}
+.markdown-body span.frame span img {
+    display: block;
+    float: left;
+}
+.markdown-body span.frame span span {
+    clear: both;
+    color: #333;
+    display: block;
+    padding: 5px 0 0;
+}
+.markdown-body span.align-center {
+    clear: both;
+    display: block;
+    overflow: hidden;
+}
+.markdown-body span.align-center > span {
+    display: block;
+    margin: 13px auto 0;
+    overflow: hidden;
+    text-align: center;
+}
+.markdown-body span.align-center span img {
+    margin: 0 auto;
+    text-align: center;
+}
+.markdown-body span.align-right {
+    clear: both;
+    display: block;
+    overflow: hidden;
+}
+.markdown-body span.align-right > span {
+    display: block;
+    margin: 13px 0 0;
+    overflow: hidden;
+    text-align: right;
+}
+.markdown-body span.align-right span img {
+    margin: 0;
+    text-align: right;
+}
+.markdown-body span.float-left {
+    display: block;
+    float: left;
+    margin-right: 13px;
+    overflow: hidden;
+}
+.markdown-body span.float-left span {
+    margin: 13px 0 0;
+}
+.markdown-body span.float-right {
+    display: block;
+    float: right;
+    margin-left: 13px;
+    overflow: hidden;
+}
+.markdown-body span.float-right > span {
+    display: block;
+    margin: 13px auto 0;
+    overflow: hidden;
+    text-align: right;
+}
+.markdown-body code, .markdown-body tt {
+    background-color: rgba(0, 0, 0, 0.04);
+    border-radius: 3px;
+    font-size: 85%;
+    margin: 0;
+    padding: 0.2em 0;
+}
+.markdown-body code:before, .markdown-body code:after, .markdown-body tt:before, .markdown-body tt:after {
+    content: " ";
+    letter-spacing: -0.2em;
+}
+.markdown-body code br, .markdown-body tt br {
+    display: none;
+}
+.markdown-body del code {
+    text-decoration: inherit;
+}
+.markdown-body pre > code {
+    background: none repeat scroll 0 0 transparent;
+    border: 0 none;
+    font-size: 100%;
+    margin: 0;
+    padding: 0;
+    white-space: pre;
+    word-break: normal;
+}
+.markdown-body .highlight {
+    margin-bottom: 16px;
+}
+.markdown-body .highlight pre, .markdown-body pre {
+    background-color: #f7f7f7;
+    border-radius: 3px;
+    font-size: 85%;
+    line-height: 1.45;
+    overflow: auto;
+    padding: 16px;
+}
+.markdown-body .highlight pre {
+    margin-bottom: 0;
+    word-break: normal;
+}
+.markdown-body pre {
+    word-wrap: normal;
+}
+.markdown-body pre code, .markdown-body pre tt {
+    background-color: transparent;
+    border: 0 none;
+    display: inline;
+    line-height: inherit;
+    margin: 0;
+    max-width: initial;
+    overflow: initial;
+    padding: 0;
+    word-wrap: normal;
+}
+.markdown-body pre code:before, .markdown-body pre code:after, .markdown-body pre tt:before, .markdown-body pre tt:after {
+    content: normal;
+}

data/app/controllers/change_log/application_controller.rb

@@ -0,0 +1,5 @@
+require 'rdiscount'
+module ChangeLog
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/change_log/base_controller.rb

@@ -0,0 +1,17 @@
+module ChangeLog
+  class BaseController < ::ApplicationController
+    layout ChangeLog.config.layout
+
+    def index
+      @items = _model.fetch(params)
+    end
+
+    def _model
+      if ChangeLog.config.orm == 'activerecord'
+        ChangeLog::ActiverecordModel
+      else
+        ChangeLog::MongoidModel
+      end
+    end
+  end
+end

data/app/helpers/change_log/application_helper.rb

@@ -0,0 +1,8 @@
+require 'kramdown'
+module ChangeLog
+  module ApplicationHelper
+    def md(string)
+      Kramdown::Document.new(string).to_html.html_safe
+    end
+  end
+end

data/app/models/change_log/activerecord_model.rb

@@ -0,0 +1,12 @@
+module ChangeLog
+  class ActiverecordModel < ActiveRecord::Base
+
+    def self.fetch(options)
+      self.order('time desc')
+    end
+
+    def self.last_release
+      last
+    end
+  end
+end

data/app/models/change_log/mongoid_model.rb

@@ -0,0 +1,20 @@
+module ChangeLog
+  class MongoidModel
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :version, type: String
+    field :author, type: String
+    field :message, type: String
+    field :time, type: DateTime
+    field :tags
+
+    def self.fetch(option)
+      all.desc('time')
+    end
+
+    def self.last_release
+      last
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+  <% @items.each do |item| %>
+      <h2> <%= item.version %> {<%= item.time %>}</h2>
+      <%= md item.message %>
+      <br/>
+  <% end %>

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ChangeLog</title>
+  <%= stylesheet_link_tag "change_log/application", :media => "all" %>
+  <%= javascript_include_tag "change_log/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<div class="markdown-body">
+  <%= yield %>
+</div>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+ChangeLog::Engine.routes.draw do
+  root :to => 'base#index'
+end

data/lib/change_log/config.rb

@@ -0,0 +1,31 @@
+require 'active_support/core_ext/class/attribute_accessors'
+
+module ChangeLog
+  module Config
+
+    class << self
+      # Table prefix to avoid collision
+      attr_accessor :table_prefix
+
+      #layout name default applocation
+      attr_accessor :layout
+
+      #commit message prefix
+      attr_accessor :commit_prefix
+
+      attr_accessor :orm
+
+      attr_accessor :tag_prefix
+
+      def reset
+        @layout = 'change_log/application'
+        @table_prefix = nil
+        @commit_prefix = '~~~'
+        @tag_prefix = '~~'
+      end
+    end
+
+    # Set default values for configuration options on load
+    self.reset
+  end
+end

data/lib/change_log/engine.rb

@@ -0,0 +1,10 @@
+module ChangeLog
+  class Engine < ::Rails::Engine
+    isolate_namespace ChangeLog
+    initializer 'change_log.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper ChangeLog::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/change_log/markdown_handler.rb

@@ -0,0 +1,14 @@
+require 'rdiscount'
+
+module MarkdownHandler
+  def self.erb
+    @erb ||= ActionView::Template.registered_template_handler(:erb)
+  end
+
+  def self.call(template)
+    compiled_source = erb.call(template)
+    "RDiscount.new(begin;#{compiled_source};end).to_html"
+  end
+end
+
+ActionView::Template.register_template_handler :md, MarkdownHandler

data/lib/change_log/version.rb

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

data/lib/change_log.rb

@@ -0,0 +1,13 @@
+require "change_log/config"
+require "change_log/engine"
+
+module ChangeLog
+  # Setup ChangeLog
+  def self.config(&block)
+    if block_given?
+      block.call(ChangeLog::Config)
+    else
+      ChangeLog::Config
+    end
+  end
+end

data/lib/generators/change_log/install_generator.rb

@@ -0,0 +1,57 @@
+require 'rails/generators'
+require File.expand_path('../utils', __FILE__)
+
+# http://guides.rubyonrails.org/generators.html
+# http://rdoc.info/github/wycats/thor/master/Thor/Actions.html
+# keep generator idempotent, thanks
+# Thanks to https://github.com/sferik/rails_admin !
+
+module ChangeLog
+  class InstallGenerator < Rails::Generators::Base
+
+    source_root File.expand_path("../templates", __FILE__)
+    include Rails::Generators::Migration
+    include Generators::Utils::InstanceMethods
+    extend Generators::Utils::ClassMethods
+
+    argument :_namespace, :type => :string, :required => false, :desc => "ChangeLog url namespace"
+    argument :_table_prefix, :type => :string, :required => false, :desc => "Prefix for change_log tables "
+    argument :_orm, :type => :string, :required => false, :desc => "ORM <activerecord or mongoid>"
+    desc "ChangeLog installation generator"
+
+    def install
+      routes = File.open(Rails.root.join("config/routes.rb")).try :read
+      initializer = (File.open(Rails.root.join("config/initializers/change_log.rb")) rescue nil).try :read
+
+      display "Hello, ChangeLog installer will help you sets things up!", :black
+      unless initializer
+        #install_generator = ask_boolean("Do you want to install the optional configuration file (to change mappings, locales dump location etc..) ?")
+        @orm = multiple_choice "Please select orm", [["ActiveRecord", "activerecord"], ["Mongoid", "mongoid"]]
+
+        _table =  @orm == 'mongoid' ? 'collection' : 'table'
+        @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."
+        template "initializer.erb", "config/initializers/change_log.rb.example"
+      end
+
+      if @orm == 'activerecord'
+        display "Adding a migration..."
+        migration_template 'migration.rb', 'db/migrate/create_change_log_tables.rb' #rescue display $!.message
+      end
+
+      namespace = ask_for("Where do you want to mount change_log?", "change_log", _namespace)
+      gsub_file "config/routes.rb", /mount ChangeLog::Engine => \'\/.+\', :as => \'change_log\' if defined\? ChangeLog/, ''
+      gsub_file "config/routes.rb", /mount ChangeLog::Engine => \'\/.+\', :as => \'change_log\'/, ''
+      gsub_file "config/routes.rb", /mount ChangeLog::Engine => \'\/.+\'/, ''
+      route("mount ChangeLog::Engine => '/#{namespace}', :as => 'change_log' if defined? ChangeLog")
+
+      display "Job's done: migrate,now modify initilizer[optional],  start your server and visit '/#{namespace}'!", :blue
+    end
+
+    def table_prefix
+      @table_prefix
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+# ChangeLog config file. Generated on <%= DateTime.now.to_s(:long) %>
+# See github.com/amuntasim/change_log for more informations
+
+  #ChangeLog::ApplicationController.authenticator = proc {
+  #  authenticate_or_request_with_http_basic('ChangeLog') do |user_name, password|
+  #    user_name == 'change_log' && password == 'password'
+  #  end
+  #}
+
+ChangeLog.config do |config|
+<% if table_prefix.present? -%>
+    config.table_prefix = '<%= table_prefix %>'
+<% else -%>
+    #config.table_prefix = ''
+<% end -%>
+
+   config.orm = '<%= @orm %>'
+
+   #config.layout = 'change_log/application'
+
+   #config.commit_prefix = '~~~'
+
+   #config.tag_prefix = '~~'
+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

@@ -0,0 +1,20 @@
+class CreateTolkTables < 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.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    add_index :<%= [table_prefix, 'change_logs'].compact.join('_') %>, :category
+
+  end
+
+  def self.down
+    drop_table :<%=[table_prefix, 'change_logs'].compact.join('_') %>
+  end
+
+end