memorable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7fb95cbd8bfc993b815802ff41abe3abf913f4f
+  data.tar.gz: 52fe4c06f792b75c26a461057ceb477b206ee30d
+SHA512:
+  metadata.gz: 746e7e131f7f1cd71c11e53a19ae00bc7e26eeb467af2026a59c400554555129d06c7a1fe765c5249264d2c688299d825eae0226e69ec809d02b52fac878f61e
+  data.tar.gz: 3a728d5a5021dee59581388cbd8493c554e95db98b86ce73c68906d1f222b3dc21b884f7f6d463537c71194f6ac66ffabd84d0e61ca8679487899190e5418267

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in easy_ping.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Xiaoguang Chen
+
+MIT License
+
+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/lib/memorable.rb

@@ -0,0 +1,22 @@
+require 'active_support'
+
+require 'memorable/version'
+require 'memorable/error'
+require 'memorable/configuration'
+require 'memorable/template_engine'
+require 'memorable/model'
+require 'memorable/controller'
+
+module Memorable
+
+  class << self
+    def setup(&block)
+      Configuration.class_eval(&block) if block_given?
+
+      Configuration.journals_model.send :include, Memorable::Model
+      ActionController::Base.send       :include, Memorable::Controller
+
+      TemplateEngine.load!
+    end
+  end
+end

data/lib/memorable/configuration.rb

@@ -0,0 +1,47 @@
+module Memorable
+  class Configuration
+    @register_actions = {}
+    @journals_model = nil
+
+    class << self
+      attr_reader :register_actions, :journals_model
+
+      def journals_model=(model)
+        model_klass = Object.const_get model.capitalize
+        @journals_model = model_klass
+      end
+
+      def register(action_names, controller_name, options, condition_proc)
+        register_actions[controller_name] ||= {}
+        register_actions[controller_name][:actions] ||= []
+        register_actions[controller_name][:actions].concat([action_names].flatten)
+        register_actions[controller_name][:options] ||= {}
+        register_actions[controller_name][:options].merge! options
+        register_actions[controller_name][:condition_proc] ||= condition_proc
+      end
+
+      def registered?(key, name)
+        register_actions[key] && register_actions[key][:actions].include?(name)
+      end
+
+      def condition_matched?(controller)
+        condition = condition_proc(controller.controller_name)
+        return true unless condition
+        return controller.instance_eval(&condition)
+      end
+
+      def controller_options(key)
+        register_actions[key][:options] rescue nil
+      end
+
+      def condition_proc(key)
+        register_actions[key][:condition_proc] rescue nil
+      end
+
+      # Controller Options Helpers
+      def  resource_name(key)
+        register_actions[key][:options][:resource_name] rescue nil
+      end
+    end
+  end
+end

data/lib/memorable/controller.rb

@@ -0,0 +1,111 @@
+module Memorable
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      append_after_filter :memorize_callback
+    end
+
+    private
+
+    def memorize_callback
+      return unless memorable?
+
+      # prepare locals for action
+      locals = extract_memorable_locals
+
+      # write to database
+      Configuration.journals_model.create_with_options!(locals)
+
+    rescue Exception => e
+      raise e if Rails.env.development? # for debug
+      Rails.logger.error e.message
+    end
+
+    def memorable?
+      Configuration.registered?(controller_name, action_name) &&
+        Configuration.condition_matched?(self) &&
+        response.successful?
+    end
+
+    def extract_memorable_locals
+      locals = ActiveSupport::HashWithIndifferentAccess.new ({
+        controller: controller_name,
+        action:     action_name,
+        user_id:    current_user.id
+      })
+
+      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_id:   memorable_resource.id,
+          resource_type: memorable_resource.class.to_s
+        })
+      end
+
+      # # Journals Model is free to override the behavior of this method
+      # if journal.respond_to? :set_attributes_for_event
+      #   journal.set_attributes_for_event(controller)
+      # end
+
+      custom_method_name = "memorable_#{action_name}"
+
+      if respond_to? custom_method_name
+        custom_locals = self.send custom_method_name
+        locals.merge!(custom_locals)
+      end
+
+      locals
+    end
+
+    def memorable_resource
+      @memorable_resource ||= self.instance_variable_get("@#{memorable_resource_name}") || self.send(:resource) rescue nil
+    end
+
+    def memorable_resource_name
+      Configuration.resource_name(controller_name) || controller_name.singularize
+    end
+
+    module ClassMethods
+      def memorize(options = {}, &block)
+        raise InvalidOptionsError, "if and unless cannot appear at the sametime" if options[:if] && options[:unless]
+
+        if condition = (options[:if] || options[:unless])
+          if_condition = !!options[:if]
+          if condition.is_a?(Symbol)
+            condition_proc = proc { |c| if_condition ? c.send(condition) : !c.send(condition) }
+          elsif condition.is_a? Proc
+            condition_proc = proc { |c| if_condition ? condition.call(c) : !condition.call(c) }
+          else
+            raise InvalidOptionsError, "#{condition} is not a valid Proc or controller method."
+          end
+        end
+
+        raise InvalidOptionsError, "except and only cannot appear at the sametime" if options[:except] && options[:only]
+
+        specified_actions = [options[:except] || options[:only]].flatten.compact.map(&:to_s)
+        actions =
+          if options.delete(:only)
+            specified_actions
+          elsif options.delete(:except)
+            all_actions - specified_actions
+          else
+            all_actions
+          end
+
+        memorize_actions actions, options, condition_proc
+      end
+
+      private
+
+      def memorize_actions(action_names, options, condition_proc)
+        Configuration.register action_names, controller_name, options, condition_proc
+      end
+
+      def all_actions
+        @all_actions ||= action_methods.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/memorable/error.rb

@@ -0,0 +1,7 @@
+module Memorable
+  class Error < StandardError; end
+  class InvalidOptionsError < Error; end
+  class InvalidYAMLData     < Error; end
+  class InvalidLocals       < Error; end
+  class TemplateNotFound    < Error; end
+end

data/lib/memorable/model.rb

@@ -0,0 +1,35 @@
+module Memorable
+
+  module Model
+    extend ActiveSupport::Concern
+
+    def write_content(options)
+      current_locale = I18n.locale
+
+      TemplateEngine.assemble(options).each do |template|
+        I18n.locale = template[0]
+        content     = template[1]
+      end
+
+      I18n.locale = current_locale
+    end
+
+    module ClassMethods
+      def create_with_options!(options={})
+        journal = self.build_with_options(options)
+        journal.save!
+      end
+
+      def build_with_options(options)
+        journal = self.new
+
+        journal.user_id       = options.delete :user_id
+        journal.resource_id   = options.delete :resource_id
+        journal.resource_type = options.delete :resource_type
+
+        journal.write_content(options)
+        journal
+      end
+    end
+  end
+end

data/lib/memorable/template_engine.rb

@@ -0,0 +1,99 @@
+require 'singleton'
+require 'yaml'
+
+module Memorable
+  class TemplateEngine
+    include Singleton
+
+    attr_reader :load_path, :templates
+
+    def initialize
+      @load_path = []
+      @templates = {}
+    end
+
+    def store_templates
+      load_path.each do |filename|
+        locale = File.basename(filename, ".yml")
+        data = load_yml filename
+        templates[locale.to_sym] = data
+      end
+    end
+
+    # Loads a YAML template file. The data must have locales as
+    # toplevel keys.
+    def load_yml(filename)
+      begin
+        YAML.load_file(filename)
+      rescue TypeError, ScriptError, StandardError => e
+        raise InvalidYAMLData.new(filename, e.inspect)
+      end
+    end
+
+    def assemble(options)
+      action_templates(options[:controller], options[:action], options[:template_key]).map do |locale, template|
+        content = render_template(template, options)
+        [locale, content]
+      end
+    end
+
+    protected
+
+    def render_template(template, locals)
+      if locals
+        I18n.interpolate(template, locals)
+      else
+        template
+      end
+    end
+
+    def action_templates(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 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
+
+    # Class Methods
+    # ----------------------
+    #
+    def self.load!
+      pattern = self.pattern_from I18n.available_locales
+
+      add("templates/#{pattern}.yml")
+      add("app/views/memorable/#{pattern}.yml", Rails.root) if defined?(Rails)
+
+      instance.store_templates
+    end
+
+    def self.assemble(*args)
+      instance.assemble(*args)
+    end
+
+    protected
+
+    def self.add(pattern, base_dir=File.dirname(__FILE__))
+      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
+  end
+end

data/lib/memorable/templates/en_US.yml

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

data/lib/memorable/version.rb

@@ -0,0 +1,3 @@
+module Memorable
+  VERSION = "0.1.1"
+end

data/memorable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memorable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memorable"
+  spec.version       = Memorable::VERSION
+  spec.authors       = ["Cxg"]
+  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, not model
+                          callbacks. Customizable ready-to-run configurations
+                          and built-in I18n support.}
+  spec.homepage      = "https://github.com/serco-chen/memorable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0") - %w[.gitignore]
+  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.add_dependency 'activesupport', '>= 3.2.8', "< 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: memorable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Cxg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  A Rails logging system based on actions, not model
+                            callbacks. Customizable ready-to-run configurations
+                            and built-in I18n support.
+email:
+- xg.chen87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- lib/memorable.rb
+- lib/memorable/configuration.rb
+- lib/memorable/controller.rb
+- lib/memorable/error.rb
+- lib/memorable/model.rb
+- lib/memorable/template_engine.rb
+- lib/memorable/templates/en_US.yml
+- lib/memorable/version.rb
+- memorable.gemspec
+homepage: https://github.com/serco-chen/memorable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: A Rails logging system based on actions.
+test_files: []