activeadmin-simpletrail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27696570a5ee60a0dbb5171556ec5c4c5dbb417f
+  data.tar.gz: 235d1b8d117d4df4a91d21f23bf99c219dba597b
+SHA512:
+  metadata.gz: f3becd28643c66cac384c4101768b95861c1e220f5d8295fd3039b8def3c3d67607b2c1f55454627abbc458efd374a9d8268e79fb207e3c6a8a321619eab44f4
+  data.tar.gz: 8452a18ffa5a4a8ec10c6d391334e45bb98b0acdce644f3ebf267f70263c00d000f602a7d542bb62bc57cd10bd43bc5774beda2f6eae6e816e10d99c278573c2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activeadmin-simpletrail.gemspec
+gemspec
+gem 'activeadmin', github: 'activeadmin'

data/README.md

@@ -0,0 +1,63 @@
+# ActiveAdmin::SimpleTrail
+Track model's changes(by activeadmin), without database migration.
+
+## Installation
+
+Add this line to your rails application's Gemfile:
+
+```ruby
+gem 'activeadmin-simpletrail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activeadmin-simpletrail
+
+## Usage
+
+In your admin file:
+
+```ruby
+ActiveAdmin.register User do
+  simple_trail action: [:update]
+  :
+  :
+```
+
+and you can log changes into file(default: `log/active_admin.log`).
+
+You can log children changes(typically `has_many` relationship changes), by using `children` attribute.
+
+```ruby
+ActiveAdmin.register User do
+  simple_trail action: [:update], children: [:contact, :posts]
+  :
+  :
+```
+
+## Configuration
+
+You can configure log's path, log's format, etc if you need.
+In `config/initializers/active_admin.rb`
+
+- `config.simple_trail_log_path`
+- `config.simple_trail_log_format`
+- `config.simple_trail_log_level`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/spacemarket/activeadmin-simpletrail/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/activeadmin-simpletrail.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_admin/simple_trail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activeadmin-simpletrail"
+  spec.version       = ActiveAdmin::SimpleTrail::VERSION
+  spec.authors       = ["Hiroaki Ninomiya"]
+  spec.email         = ["ninomiya@spacemarket.co.jp"]
+
+  spec.summary       = %q{Simple paper trail for activeadmin.}
+  spec.description   = %q{Track model's changes(by activeadmin), without database migration.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sass-rails"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activeadmin/simpletrail"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_admin/simple_trail/core_ext/application.rb

@@ -0,0 +1,7 @@
+module ActiveAdmin
+  class Application
+    inheritable_setting :simple_trail_log_path, 'log/simple_trail.log'
+    inheritable_setting :simple_trail_log_format, "#<action> #<model>(ID:#<model_id>) by #<user>\t#<changes>"
+    inheritable_setting :simple_trail_log_level, :info
+  end
+end

data/lib/active_admin/simple_trail/core_ext/resource_dsl.rb

@@ -0,0 +1,25 @@
+module ActiveAdmin
+  class ResourceDSL
+    def simple_trail(options = {}, &block)
+      actions = options[:actions] || [:update]
+      children = options[:children] || []
+
+      actions.each do |act|
+        hook_name = "before_#{act.to_s}".to_sym
+        next unless self.respond_to? hook_name
+        self.send(hook_name, -> target do
+          ActiveAdmin::SimpleTrail.write_log(act, target, current_admin_user.email) if target.changed?
+          children.each do |child|
+            next unless target.respond_to? child
+            next unless target.send(child)
+            child_targets = target.send(child)
+            child_targets = [child_targets] unless child_targets.respond_to? :each
+            child_targets.each do |child_target|
+              ActiveAdmin::SimpleTrail.write_log(act, child_target, current_admin_user.email) if child_target.changed?
+            end
+          end
+        end)
+      end
+    end
+  end
+end

data/lib/active_admin/simple_trail/version.rb

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module SimpleTrail
+    VERSION = "0.1.0"
+  end
+end

data/lib/active_admin/simple_trail.rb

@@ -0,0 +1,26 @@
+require "active_admin"
+require "active_admin/simple_trail/version"
+require "active_admin/simple_trail/core_ext/resource_dsl"
+require "active_admin/simple_trail/core_ext/application"
+
+module ActiveAdmin
+  module SimpleTrail
+    def self.write_log(action, target, user)
+      logger.send(config.simple_trail_log_level,
+        config.simple_trail_log_format.gsub('#<action>', action.to_s).
+        gsub('#<model>', target.class.name.downcase).
+        gsub('#<model_id>', target.id.to_s).
+        gsub('#<user>', user.to_s).
+        gsub('#<changes>', target.changes.to_s))
+    end
+
+    private
+    def self.logger
+      @@logger ||= Logger.new(config.simple_trail_log_path)
+    end
+
+    def self.config
+      ActiveAdmin.application
+    end
+  end
+end

data/lib/activeadmin/simpletrail.rb

@@ -0,0 +1 @@
+require 'active_admin/simple_trail'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin-simpletrail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiroaki Ninomiya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Track model's changes(by activeadmin), without database migration.
+email:
+- ninomiya@spacemarket.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activeadmin-simpletrail.gemspec
+- bin/console
+- bin/setup
+- lib/active_admin/simple_trail.rb
+- lib/active_admin/simple_trail/core_ext/application.rb
+- lib/active_admin/simple_trail/core_ext/resource_dsl.rb
+- lib/active_admin/simple_trail/version.rb
+- lib/activeadmin/simpletrail.rb
+homepage: ''
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Simple paper trail for activeadmin.
+test_files: []