has_logs 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0516f9656458af72a2042060e87ae6a7252fad6
+  data.tar.gz: 1eb28b3e1cd5e84184191c4711a5df7f5466ece0
+SHA512:
+  metadata.gz: 162d25cbbf867d35ec009e726eb9b0ce7da855eceef0fba95df3338bcd058ae89e8e40ae1d62f21108c855fbeab1627b0c4e31ada17fbd7692eab8048c15107e
+  data.tar.gz: aaffb45bcedd6103e14444d172d4dd59a336a0468ebcd33952b7f2a9c62efaa125b60b510aa9588bb1c9f35e9ae373adb90085a7320e5e3188649abd72b54ef0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at isuke770@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 isuke
+
+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.md

@@ -0,0 +1,105 @@
+# HasLogs
+
+Logging your ActiveRecord model, and supply useful methods.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_logs'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install has_logs
+```
+
+## Basic Example
+
+### First Migration
+
+```ruby
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:articles) do |t|
+      t.timestamps
+    end
+
+    create_table(:article_logs) do |t|
+      t.integer :article_id, null: false
+      t.string :title, null: false
+      t.text :content
+      t.boolean :public, null: false, default: true
+      t.datetime :created_at
+    end
+    add_index :article_logs,  :article_id
+    add_index :article_logs, [:article_id, :created_at], unique: true
+  end
+end
+```
+
+## Model Class
+
+```ruby
+class Article < ActiveRecord::Base
+  has_logs
+end
+
+class ArticleLog < ActiveRecord::Base
+  act_as_log
+end
+```
+
+## Usage Examples
+
+```ruby
+article = Article.create(title: 'test1', content: 'demo1', public: false)
+article.attributes =   { title: 'test2', content: 'demo2', public: false } ; article.save!
+article.attributes =   { title: 'test3', content: 'demo3', public: true  } ; article.save!
+
+article.title
+=> 'test3'
+
+article.logs
+=> [#<ArticleLog id: 1, article_id: 1, title: "test1", content: "demo1", created_at: "2015-01-04 03:36:51">,
+ #<ArticleLog id: 2, article_id: 1, title: "test2", content: "demo2", created_at: "2015-01-04 03:36:51">,
+ #<ArticleLog id: 3, article_id: 1, title: "test3", content: "demo3", created_at: "2015-01-04 03:36:51">]
+
+article.oldest_log
+=> #<ArticleLog id: 1, article_id: 1, title: "test1", content: "demo1", created_at: "2015-01-04 03:36:51">
+
+article.latest_log
+=> #<ArticleLog id: 3, article_id: 1, title: "test3", content: "demo3", created_at: "2015-01-04 03:36:51">
+
+article.oldest_log.next
+=> #<ArticleLog id: 2, article_id: 1, title: "test2", content: "demo2", created_at: "2015-01-04 03:36:51">
+
+article.latest_log.prev
+=> #<ArticleLog id: 2, article_id: 1, title: "test2", content: "demo2", created_at: "2015-01-04 03:36:51">
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/isuke/has_logs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "has_logs"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/has_logs.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_logs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_logs"
+  spec.version       = HasLogs::VERSION
+  spec.authors       = ["isuke"]
+  spec.email         = ["isuke770@gmail.com"]
+
+  spec.summary       = %q{Logging your ActiveRecord model.}
+  spec.description   = %q{Logging your ActiveRecord model, and supply useful methods.}
+  spec.homepage      = "https://github.com/isuke/has_logs"
+  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_dependency "activesupport", "> 3.0"
+  spec.add_dependency "activerecord", "> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "sqlite3", "~> 1.0"
+end

data/lib/has_logs/act_as_log.rb

@@ -0,0 +1,43 @@
+module HasLogs
+  module ActAsLog
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def act_as_log_of(class_name = nil, options = {})
+        act_as_log(options.merge(class_name: class_name))
+      end
+
+      def act_as_log(options = {})
+        return if self.included_modules.include?(ActAsLog::InstanceMethods)
+        include ActAsLog::InstanceMethods
+
+        cattr_accessor :originator_class_name
+
+        self.originator_class_name = options[:class_name] || (self.name.gsub /Log\Z/, '')
+
+        class_eval do
+          belongs_to :originator, options.merge(class_name: originator_class_name, foreign_key: "#{originator_class_name.underscore}_id", touch: true)
+
+          validates :"#{originator_class_name.underscore}_id", presence: true, uniqueness: { scope: :created_at }
+        end
+      end
+
+      def originator_class
+        originator_class_name.constantize
+      end
+    end
+
+    module InstanceMethods
+      def next
+        originator.logs.where("created_at > ?", self.created_at).order(:created_at).first
+      end
+
+      def prev
+        originator.logs.where("created_at < ?", self.created_at).order(:created_at).last
+      end
+    end
+
+  end
+end

data/lib/has_logs/has_logs.rb

@@ -0,0 +1,67 @@
+module HasLogs
+  module HasLogs
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def has_logs_as(class_name = nil, options = {})
+        has_logs(options.merge(class_name: class_name))
+      end
+
+      def has_logs(options = {})
+        return if self.included_modules.include?(HasLogs::InstanceMethods)
+        include HasLogs::InstanceMethods
+
+        cattr_accessor :log_class_name, :log_foreign_key, :log_table_name, :logging_attrs
+
+        self.log_class_name  = options[:class_name]  || "#{self.name}Log"
+        self.log_foreign_key = options[:foreign_key] || "#{self.name}Id".underscore
+
+        self.logging_attrs = (log_class.column_names - [log_class.primary_key, "#{self.name}Id".underscore, 'created_at'])
+
+        class_eval do
+          has_many :logs, options.merge(class_name: log_class_name, foreign_key: log_foreign_key)
+          after_find   :set_attrs
+          after_create :create_log
+          after_update :create_log
+
+          logging_attrs.each do |attr|
+            attr_accessor attr
+            define_method "#{attr}?" do
+              public_send(:attr).present?
+            end
+          end
+        end
+      end
+
+      def log_class
+        log_class_name.constantize
+      end
+    end
+
+    module InstanceMethods
+      def latest_log
+        logs.order(:created_at).last
+      end
+
+      def oldest_log
+        logs.order(:created_at).first
+      end
+
+      def create_log
+        values = {}
+        self.class.logging_attrs.each do |attr|
+          values[attr] = send(attr)
+        end
+        logs.build(values).save
+      end
+
+      def set_attrs
+        self.class.logging_attrs.each do |attr|
+          self.send("#{attr}=", latest_log.try(:"#{attr}"))
+        end
+      end
+    end
+  end
+end

data/lib/has_logs/version.rb

@@ -0,0 +1,3 @@
+module HasLogs
+  VERSION = "0.5.0"
+end

data/lib/has_logs.rb

@@ -0,0 +1,11 @@
+require "has_logs/version"
+require 'active_support'
+require 'active_record'
+require 'has_logs/has_logs'
+require 'has_logs/act_as_log'
+
+module HasLogs
+end
+
+ActiveRecord::Base.include HasLogs::HasLogs
+ActiveRecord::Base.include HasLogs::ActAsLog

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: has_logs
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- isuke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: shoulda
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Logging your ActiveRecord model, and supply useful methods.
+email:
+- isuke770@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- has_logs.gemspec
+- lib/has_logs.rb
+- lib/has_logs/act_as_log.rb
+- lib/has_logs/has_logs.rb
+- lib/has_logs/version.rb
+homepage: https://github.com/isuke/has_logs
+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.1
+signing_key: 
+specification_version: 4
+summary: Logging your ActiveRecord model.
+test_files: []