memorable 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4605915b94644c1cf4eec46d551ea971637c61b
-  data.tar.gz: 1d8e9deda6b5a1cb73dd82cd078d2bc108234a2f
+  metadata.gz: b1c1a0cf58461321fd1ebd8a9f3a651f867bb724
+  data.tar.gz: 0410ce862905268bc71994f35993b5c67d2afc97
 SHA512:
-  metadata.gz: 017ee728f18ac91a52790617457d9910e6f9025a14ef2d75c34ecff817bc67dcb6ecf4ffca203b18dc85311d540643c65eb27dcc0749fc49197a58ec59b7a860
-  data.tar.gz: 420b4c3b0b1cdc0482dbdbf7768c59911fc3b1f0de0f74d00b2f7dd2d6602ca96327e3db475815161ee01d67a452712968ccbdd8f831124b0865a2801a314142
+  metadata.gz: b9fdb08440094d599523551036dd01d97ac863de4b8463127bad6a253ef317fa0edfb9038fe130056009768f4195d42f4698b328447f99846250e498d1ab9797
+  data.tar.gz: bb705ce042ee5b337926b4e0c67f4062b2ff9cfb0e131f4289a168821462f9320e28bcbac8e8618b68e0ab2ed34a42feb53939aff70688db264f4e591f9d0fa1

data/README.md

@@ -31,6 +31,23 @@ gem install memorable-<VERSION>.gem
 
 ## Configuration
 
+run:
+
+    $ rails g memorable:install MODELNAME
+
+or ('journal' is the default name if not given one)
+
+    $ rails g memorable:install
+
+This command will create 4 files for you to start with:
+
+1. `db/migration/20150228032852_create_memorable_journal.rb`
+2. `app/models/journal.rb`
+3. `config/initializers/memorable.rb`
+4. `config/locales/memorable.en.yml`
+
+Or you can manually setup as follows:
+
 ### Initializer
 
 Write these lines of code to your configuration file, for example, `memorable.rb`.
@@ -60,17 +77,13 @@ class CreateJournal < ActiveRecord::Migration
       t.integer :resource_id
       t.string  :resource_type
       t.text    :meta
+      t.text    :content
 
       t.timestamps
     end
 
     add_index :journals, :user_id
     add_index :journals, :resource_id
-
-    # If you are not using globalize, https://github.com/globalize/globalize,
-    # comment this line and add a field named content into your journals table.
-    # eg: t.text :content
-    Journal.create_translation_table! :content => :text
   end
 
   def down
@@ -78,9 +91,6 @@ class CreateJournal < ActiveRecord::Migration
     remove_index :journals, :resource_id
 
     drop_table :journals
-
-    # If you are not using globalize, comment this line
-    Journal.drop_translation_table!
   end
 end
 ```
@@ -97,12 +107,11 @@ Create a ActiveRecord Model, and you are all set.
 
 ```ruby
 class Journal < ActiveRecord::Base
-  attr_accessible :resource_id, :resource_type, :user_id, :meta, :content
+  include Memorable::Model
 
-  store :meta, accessors: [:controller, :action, :template_key ]
+  attr_accessible :resource_id, :resource_type, :user_id, :meta, :content
 
-  # If you are not using globalize, comment this line
-  translates :content, :fallbacks_for_empty_translations => true
+  store :meta
 
   belongs_to :user
   belongs_to :resource, polymorphic: true, :touch => true
@@ -111,30 +120,47 @@ end
 
 ## Usage
 
+Specify which actions you would like to log:
+
+```ruby
+class ContactsController < ApplicationController
+  memorize :only => [:create, :update]
+end
+```
+
+`memorize` method support following options:
+
+```
+- only, except  # It's used to specify action names to log
+- resource_name # Use to detect resource in special case
+- if, unless    # Add condition wheter to log or not
+```
+
 Add your own templates using yaml, this gem ships with a default yml template engine.
 
-Put your templates under `app/views/memorable` directory of you project, and name them with something like `en_US.yml`
+Put your templates under `config/locales` directory of you project, and name them with something like `memorable.en.yml`
 
 Here's an example of a typical template file
 
 ```
-defaults:
-  create:
-    base: "%{resource_type} created."
-  update:
-    base: "%{resource_type} updated."
-  destroy:
-    base: "%{resource_type} deleted."
-  others:
-    base: "%{action} was executed on %{resource_type}."
-contacts:
-  create:
-    base:  "Added vendor %{name} to Vendor Library."
-  update:
-    base: "Edited information for Vendor %{name}."
-    name: "Change Vendor Name form %{previous_name} to %{name}."
-  destroy:
-    base: "Deleted Vendor %{name}."
+en:
+  memorable:
+    defaults:
+      create:
+        base: "%{resource_type} %{resource_id} created."
+      update:
+        base: "%{resource_type} %{resource_id} updated."
+      destroy:
+        base: "%{resource_type} %{resource_id} deleted."
+
+    contacts:
+      create:
+        base:  "Added vendor %{name} to Vendor Library."
+      update:
+        base: "Edited information for Vendor %{name}."
+        name: "Change Vendor Name form %{previous_name} to %{name}."
+      destroy:
+        base: "Deleted Vendor %{name}."
 ```
 
 As you can see, controller_name and action_name are used as the first two levels of template_keys.
@@ -153,7 +179,7 @@ class ContactsController < ApplicationController
   private
 
     def memorable_update
-      if @contact.previous_changes.key? [:name]
+      if @contact.previous_changes.key? :name
         {template_key: 'name', company_email: @contact.company.email}
       end
     end

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  memorable:
+    defaults:
+      create:
+        base: "%{resource_type} %{resource_id} created."
+      update:
+        base: "%{resource_type} %{resource_id} updated."
+      destroy:
+        base: "%{resource_type} %{resource_id} deleted."

data/lib/generators/active_record/memorable_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class MemorableGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Create a migration to create a table for logging. "
+
+      def generate_migration
+        migration_template "migration.rb.erb", "db/migrate/#{migration_file_name}"
+      end
+
+      protected
+
+      def migration_name
+        "create_memorable_#{table_name}"
+      end
+
+      def migration_file_name
+        "#{migration_name}.rb"
+      end
+
+      def migration_class_name
+        migration_name.camelize
+      end
+    end
+  end
+end

data/lib/generators/memorable/install_generator.rb

@@ -0,0 +1,35 @@
+require 'rails/generators/base'
+
+module Memorable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Memorable initializer and copy locale files to your application."
+
+      argument :model_name, :type => :string, :default => "journal",
+              :desc => "The name of logging model.",
+              :banner => "Logging model name, eg: journal"
+
+      def invoke_migration_generator
+        generate "active_record:memorable #{model_name.pluralize}"
+      end
+
+      def copy_model_file
+        template "model.rb.erb", "app/models/#{model_name}.rb"
+      end
+
+      def copy_initializer
+        template "memorable.rb.erb", "config/initializers/memorable.rb"
+      end
+
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/memorable.en.yml"
+      end
+
+      # def show_readme
+      #   readme "README" if behavior == :invoke
+      # end
+    end
+  end
+end

data/lib/generators/templates/memorable.rb.erb

@@ -0,0 +1,6 @@
+Memorable.setup do |config|
+  config.journals_model = <%= model_name.capitalize %>
+
+  # Specify template engine, default
+  # config.template_engine = DefaultYAMLEngine
+end

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

@@ -0,0 +1,23 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def up
+    create_table :<%= table_name %> do |t|
+      t.integer :user_id
+      t.integer :resource_id
+      t.string  :resource_type
+      t.text    :meta
+      t.text    :content
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :user_id
+    add_index :<%= table_name %>, :resource_id
+  end
+
+  def down
+    remove_index :<%= table_name %>, :user_id
+    remove_index :<%= table_name %>, :resource_id
+
+    drop_table :<%= table_name %>
+  end
+end

data/lib/generators/templates/model.rb.erb

@@ -0,0 +1,10 @@
+class <%= model_name.capitalize %> < ActiveRecord::Base
+  include Memorable::Model
+
+  attr_accessible :resource_id, :resource_type, :user_id, :meta, :content
+
+  store :meta
+
+  belongs_to :user
+  belongs_to :resource, polymorphic: true, :touch => true
+end

data/lib/memorable.rb

@@ -15,14 +15,9 @@ module Memorable
 
     def setup(&block)
       yield config if block_given?
-
-      config.journals_model.send  :include, Memorable::Model
       ActionController::Base.send :include, Memorable::Controller
 
-      config.default_templates_directory ||= File.dirname(__FILE__)
-      config.template_engine             ||= DefaultYAMLEngine
-
-      config.template_engine.load!
+      config.template_engine ||= DefaultYAMLEngine
     end
   end
 end

data/lib/memorable/controller.rb

@@ -3,7 +3,11 @@ module Memorable
     extend ActiveSupport::Concern
 
     included do
-      append_after_filter :memorize_callback
+      if Rails::VERSION::MAJOR > 3
+        append_after_action :memorize_callback
+      else
+        append_after_filter :memorize_callback
+      end
     end
 
     private
@@ -12,10 +16,10 @@ module Memorable
       return unless memorable?
 
       # prepare locals for action
-      locals = extract_memorable_locals
+      options = extract_memorable_options
 
       # write to database
-      Memorable.config.journals_model.create_with_options!(locals)
+      Memorable.config.journals_model.create_with_params!(options)
 
     rescue Exception => e
       raise e if Rails.env.development? # for debug
@@ -28,30 +32,35 @@ module Memorable
         response.successful?
     end
 
-    def extract_memorable_locals
-      locals = ActiveSupport::HashWithIndifferentAccess.new ({
-        controller: controller_name,
-        action:     action_name,
-        user_id:    current_user.id
+    def extract_memorable_options
+      options = ActiveSupport::HashWithIndifferentAccess.new ({
+        user_id: current_user.try(:id),
+        meta: {
+          controller: controller_name,
+          action:     action_name
+        }
       })
 
       if memorable_resource
-        locals.merge! Hash[memorable_resource.previous_changes.map {|key, value| ["previous_#{key}", value[0]]}]
-        locals.merge! memorable_resource.attributes
-        locals.merge!({
+        resource_previous   = Hash[memorable_resource.previous_changes.map {|key, value| ["previous_#{key}", value[0]]}]
+        resource_attributes = memorable_resource.attributes
+        resource_options    = {
           resource_id:   memorable_resource.id,
           resource_type: memorable_resource.class.to_s
-        })
+        }
+
+        options[:meta].merge!(resource_previous).merge!(resource_attributes).merge!(resource_options)
+        options.merge!(resource_options)
       end
 
       custom_method_name = "memorable_#{action_name}"
 
       if respond_to? custom_method_name, true
         custom_locals = self.send custom_method_name
-        locals.merge!(custom_locals) if custom_locals.is_a?(Hash)
+        options[:meta].merge!(custom_locals) if custom_locals.is_a?(Hash)
       end
 
-      locals
+      options
     end
 
     def memorable_resource

data/lib/memorable/model.rb

@@ -3,33 +3,33 @@ module Memorable
   module Model
     extend ActiveSupport::Concern
 
-    def write_content(options)
-      current_locale = I18n.locale
+    def write_content(locals)
+      self.content = memorable_content(locals)
+    end
 
-      Memorable.config.template_engine.assemble(options).each do |template|
-        I18n.locale  = template[0]
-        self.content = template[1]
-      end
+    private
 
-      I18n.locale = current_locale
+    def memorable_content(*args)
+      Memorable.config.template_engine.run(*args)
     end
 
     module ClassMethods
-      def create_with_options!(options={})
-        journal = self.build_with_options(options)
-        journal.save!
+      def create_with_params!(params={})
+        instance = self.build_with_params(params)
+        instance.save!
       end
 
-      def build_with_options(options)
-        journal = self.new
+      def build_with_params(params)
+        instance = self.new
 
-        journal.user_id       = options.delete :user_id
-        journal.resource_id   = options.delete :resource_id
-        journal.resource_type = options.delete :resource_type
-        journal.meta          = options if journal.respond_to?(:meta)
+        # set attributes and meta data if possible
+        params.each do |key, value|
+          instance.send "#{key}=", value if instance.respond_to?(key)
+        end
 
-        journal.write_content(options)
-        journal
+        # render content with meta data
+        instance.write_content(params[:meta])
+        instance
       end
     end
   end

data/lib/memorable/template_engine.rb

@@ -1,42 +1,17 @@
-require 'singleton'
-
 module Memorable
 
   # This is an abstract class, do not use it directly. Inherit from this class
-  # and implement custom load!/parse/render medthods.
+  # and implement custom render medthods.
   class TemplateEngine
-    include Singleton
-
-    # Class Methods
-    # --------------------------
-    # Override this method in subclass
-    def self.load!
-    end
-
-    def self.assemble(*args)
-      instance.assemble(*args)
-    end
-
-    # Instance Methods
-    # --------------------------
-    #
-    attr_reader :load_path, :templates
 
-    def initialize
-      @load_path = []
-      @templates = {}
-    end
-
-    def assemble(options)
-      parse(options[:controller], options[:action], options[:template_key]).map do |locale, template|
-        content = render(template, options)
-        [locale, content]
-      end
+    def self.run(*args)
+      self.new.render(*args)
     end
 
     # Override this method in subclass
-    def parse(controller, action, sub_key)
+    def render(*args)
     end
+
   end
 end
 

data/lib/memorable/template_engines/default.rb

@@ -1,79 +1,19 @@
-require 'yaml'
-
 module Memorable
-  class DefaultYAMLEngine < TemplateEngine
-
-    # Class Methods
-    # --------------------------
-    # load yaml templates
-    def self.load!
-      pattern = self.pattern_from I18n.available_locales
-
-      add("memorable/templates/#{pattern}.yml", Memorable.config.default_templates_directory)
-      add("app/views/memorable/#{pattern}.yml", Rails.root) if defined?(Rails)
-
-      instance.store_templates
-    end
-
-    def self.add(pattern, base_dir)
-      files = Dir[File.join(base_dir, pattern)]
-      instance.load_path.concat(files)
-    end
-
-    def self.pattern_from(args)
-      array = Array(args || [])
-      array.blank? ? '*' : "{#{array.join ','}}"
-    end
-
-    # Instance Methods
-    # --------------------------
-    #
-    def store_templates
-      load_path.each do |filename|
-        locale = File.basename(filename, ".yml")
-        data = load_yml filename
-        templates[locale.to_sym] = data
-      end
-    end
-
-    def parse(controller, action, sub_key)
-      sub_key ||= 'base'
-      raw_templates = catch(:template_found) do
-        parse_entry(controller, action, sub_key)
-        parse_entry(controller, 'other', sub_key)
-        parse_entry('defaults', action, sub_key)
-        parse_entry('defaults', 'other', sub_key)
-        nil
-      end
-      raise TemplateNotFound, "Template: #{controller} #{action} #{sub_key} not found" unless raw_templates
-      raw_templates
-    end
 
-    def render(template, locals)
-      if locals
-        I18n.interpolate(template, locals)
-      else
-        template
-      end
-    end
-
-    private
+  # This is the default engine, which uses I18n to find the template and
+  # to interpolate variables.
+  class DefaultYAMLEngine < TemplateEngine
 
-    # Loads a YAML template file.
-    def load_yml(filename)
+    def render(locals)
+      controller, action, sub_key = locals[:controller], locals[:action], locals[:template_key] || 'base'
+      @key ||= "memorable.#{controller}.#{action}.#{sub_key}"
       begin
-        YAML.load_file(filename)
-      rescue TypeError, ScriptError, StandardError => e
-        raise InvalidYAMLData.new(filename, e.inspect)
+        I18n.t! @key, locals
+      rescue I18n::MissingTranslationData => e
+        raise e if @key.start_with?("memorable.defaults")
+        @key = "memorable.defaults.#{action}.#{sub_key}"
+        retry
       end
     end
-
-    def parse_entry(controller, action, sub_key)
-      raw_templates = templates.map do |locale, template_data|
-        template = template_data[controller][action][sub_key] rescue nil
-        template ? [locale, template] : nil
-      end.compact
-      throw :template_found, raw_templates unless raw_templates.blank?
-    end
   end
 end

data/lib/memorable/version.rb

@@ -1,3 +1,3 @@
 module Memorable
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/memorable.gemspec

@@ -1,12 +1,11 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.push File.expand_path("../lib", __FILE__)
 require 'memorable/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "memorable"
   spec.version       = Memorable::VERSION
-  spec.authors       = ["Cxg"]
+  spec.authors       = ["Xiaoguang Chen"]
   spec.email         = ["xg.chen87@gmail.com"]
   spec.summary       = "A Rails logging system based on actions."
   spec.description   = %q{A Rails logging system based on actions, instead of
@@ -19,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_dependency 'activesupport', '>= 3.2.8', "< 5.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memorable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
-- Cxg
+- Xiaoguang Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -71,6 +71,12 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- config/locales/en.yml
+- lib/generators/active_record/memorable_generator.rb
+- lib/generators/memorable/install_generator.rb
+- lib/generators/templates/memorable.rb.erb
+- lib/generators/templates/migration.rb.erb
+- lib/generators/templates/model.rb.erb
 - lib/memorable.rb
 - lib/memorable/controller.rb
 - lib/memorable/error.rb
@@ -78,7 +84,6 @@ files:
 - lib/memorable/registration.rb
 - lib/memorable/template_engine.rb
 - lib/memorable/template_engines/default.rb
-- lib/memorable/templates/en_US.yml
 - lib/memorable/version.rb
 - memorable.gemspec
 homepage: https://github.com/serco-chen/memorable
@@ -93,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/memorable/templates/en_US.yml

@@ -1,9 +0,0 @@
-defaults:
-  create:
-    base: "%{resource_type} created."
-  update:
-    base: "%{resource_type} updated."
-  destroy:
-    base: "%{resource_type} deleted."
-  others:
-    base: "%{action} was executed on %{resource_type}."