has_logs 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: d0516f9656458af72a2042060e87ae6a7252fad6
4
+ data.tar.gz: 1eb28b3e1cd5e84184191c4711a5df7f5466ece0
5
+ SHA512:
6
+ metadata.gz: 162d25cbbf867d35ec009e726eb9b0ce7da855eceef0fba95df3338bcd058ae89e8e40ae1d62f21108c855fbeab1627b0c4e31ada17fbd7692eab8048c15107e
7
+ data.tar.gz: aaffb45bcedd6103e14444d172d4dd59a336a0468ebcd33952b7f2a9c62efaa125b60b510aa9588bb1c9f35e9ae373adb90085a7320e5e3188649abd72b54ef0
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ /vendor/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at isuke770@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in has_logs.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 isuke
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,105 @@
1
+ # HasLogs
2
+
3
+ Logging your ActiveRecord model, and supply useful methods.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'has_logs'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ ```
18
+ $ bundle
19
+ ```
20
+
21
+ Or install it yourself as:
22
+
23
+ ```
24
+ $ gem install has_logs
25
+ ```
26
+
27
+ ## Basic Example
28
+
29
+ ### First Migration
30
+
31
+ ```ruby
32
+ class CreateAllTables < ActiveRecord::Migration
33
+ def self.up
34
+ create_table(:articles) do |t|
35
+ t.timestamps
36
+ end
37
+
38
+ create_table(:article_logs) do |t|
39
+ t.integer :article_id, null: false
40
+ t.string :title, null: false
41
+ t.text :content
42
+ t.boolean :public, null: false, default: true
43
+ t.datetime :created_at
44
+ end
45
+ add_index :article_logs, :article_id
46
+ add_index :article_logs, [:article_id, :created_at], unique: true
47
+ end
48
+ end
49
+ ```
50
+
51
+ ## Model Class
52
+
53
+ ```ruby
54
+ class Article < ActiveRecord::Base
55
+ has_logs
56
+ end
57
+
58
+ class ArticleLog < ActiveRecord::Base
59
+ act_as_log
60
+ end
61
+ ```
62
+
63
+ ## Usage Examples
64
+
65
+ ```ruby
66
+ article = Article.create(title: 'test1', content: 'demo1', public: false)
67
+ article.attributes = { title: 'test2', content: 'demo2', public: false } ; article.save!
68
+ article.attributes = { title: 'test3', content: 'demo3', public: true } ; article.save!
69
+
70
+ article.title
71
+ => 'test3'
72
+
73
+ article.logs
74
+ => [#<ArticleLog id: 1, article_id: 1, title: "test1", content: "demo1", created_at: "2015-01-04 03:36:51">,
75
+ #<ArticleLog id: 2, article_id: 1, title: "test2", content: "demo2", created_at: "2015-01-04 03:36:51">,
76
+ #<ArticleLog id: 3, article_id: 1, title: "test3", content: "demo3", created_at: "2015-01-04 03:36:51">]
77
+
78
+ article.oldest_log
79
+ => #<ArticleLog id: 1, article_id: 1, title: "test1", content: "demo1", created_at: "2015-01-04 03:36:51">
80
+
81
+ article.latest_log
82
+ => #<ArticleLog id: 3, article_id: 1, title: "test3", content: "demo3", created_at: "2015-01-04 03:36:51">
83
+
84
+ article.oldest_log.next
85
+ => #<ArticleLog id: 2, article_id: 1, title: "test2", content: "demo2", created_at: "2015-01-04 03:36:51">
86
+
87
+ article.latest_log.prev
88
+ => #<ArticleLog id: 2, article_id: 1, title: "test2", content: "demo2", created_at: "2015-01-04 03:36:51">
89
+ ```
90
+
91
+ ## Development
92
+
93
+ 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.
94
+
95
+ 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).
96
+
97
+ ## Contributing
98
+
99
+ 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.
100
+
101
+
102
+ ## License
103
+
104
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
105
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "has_logs"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/has_logs.gemspec ADDED
@@ -0,0 +1,30 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'has_logs/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "has_logs"
8
+ spec.version = HasLogs::VERSION
9
+ spec.authors = ["isuke"]
10
+ spec.email = ["isuke770@gmail.com"]
11
+
12
+ spec.summary = %q{Logging your ActiveRecord model.}
13
+ spec.description = %q{Logging your ActiveRecord model, and supply useful methods.}
14
+ spec.homepage = "https://github.com/isuke/has_logs"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency "activesupport", "> 3.0"
23
+ spec.add_dependency "activerecord", "> 3.0"
24
+ spec.add_development_dependency "bundler", "~> 1.12"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ spec.add_development_dependency "rspec-its"
28
+ spec.add_development_dependency "shoulda"
29
+ spec.add_development_dependency "sqlite3", "~> 1.0"
30
+ end
@@ -0,0 +1,43 @@
1
+ module HasLogs
2
+ module ActAsLog
3
+ def self.included(base)
4
+ base.extend ClassMethods
5
+ end
6
+
7
+ module ClassMethods
8
+ def act_as_log_of(class_name = nil, options = {})
9
+ act_as_log(options.merge(class_name: class_name))
10
+ end
11
+
12
+ def act_as_log(options = {})
13
+ return if self.included_modules.include?(ActAsLog::InstanceMethods)
14
+ include ActAsLog::InstanceMethods
15
+
16
+ cattr_accessor :originator_class_name
17
+
18
+ self.originator_class_name = options[:class_name] || (self.name.gsub /Log\Z/, '')
19
+
20
+ class_eval do
21
+ belongs_to :originator, options.merge(class_name: originator_class_name, foreign_key: "#{originator_class_name.underscore}_id", touch: true)
22
+
23
+ validates :"#{originator_class_name.underscore}_id", presence: true, uniqueness: { scope: :created_at }
24
+ end
25
+ end
26
+
27
+ def originator_class
28
+ originator_class_name.constantize
29
+ end
30
+ end
31
+
32
+ module InstanceMethods
33
+ def next
34
+ originator.logs.where("created_at > ?", self.created_at).order(:created_at).first
35
+ end
36
+
37
+ def prev
38
+ originator.logs.where("created_at < ?", self.created_at).order(:created_at).last
39
+ end
40
+ end
41
+
42
+ end
43
+ end
@@ -0,0 +1,67 @@
1
+ module HasLogs
2
+ module HasLogs
3
+ def self.included(base)
4
+ base.extend ClassMethods
5
+ end
6
+
7
+ module ClassMethods
8
+ def has_logs_as(class_name = nil, options = {})
9
+ has_logs(options.merge(class_name: class_name))
10
+ end
11
+
12
+ def has_logs(options = {})
13
+ return if self.included_modules.include?(HasLogs::InstanceMethods)
14
+ include HasLogs::InstanceMethods
15
+
16
+ cattr_accessor :log_class_name, :log_foreign_key, :log_table_name, :logging_attrs
17
+
18
+ self.log_class_name = options[:class_name] || "#{self.name}Log"
19
+ self.log_foreign_key = options[:foreign_key] || "#{self.name}Id".underscore
20
+
21
+ self.logging_attrs = (log_class.column_names - [log_class.primary_key, "#{self.name}Id".underscore, 'created_at'])
22
+
23
+ class_eval do
24
+ has_many :logs, options.merge(class_name: log_class_name, foreign_key: log_foreign_key)
25
+ after_find :set_attrs
26
+ after_create :create_log
27
+ after_update :create_log
28
+
29
+ logging_attrs.each do |attr|
30
+ attr_accessor attr
31
+ define_method "#{attr}?" do
32
+ public_send(:attr).present?
33
+ end
34
+ end
35
+ end
36
+ end
37
+
38
+ def log_class
39
+ log_class_name.constantize
40
+ end
41
+ end
42
+
43
+ module InstanceMethods
44
+ def latest_log
45
+ logs.order(:created_at).last
46
+ end
47
+
48
+ def oldest_log
49
+ logs.order(:created_at).first
50
+ end
51
+
52
+ def create_log
53
+ values = {}
54
+ self.class.logging_attrs.each do |attr|
55
+ values[attr] = send(attr)
56
+ end
57
+ logs.build(values).save
58
+ end
59
+
60
+ def set_attrs
61
+ self.class.logging_attrs.each do |attr|
62
+ self.send("#{attr}=", latest_log.try(:"#{attr}"))
63
+ end
64
+ end
65
+ end
66
+ end
67
+ end
@@ -0,0 +1,3 @@
1
+ module HasLogs
2
+ VERSION = "0.5.0"
3
+ end
data/lib/has_logs.rb ADDED
@@ -0,0 +1,11 @@
1
+ require "has_logs/version"
2
+ require 'active_support'
3
+ require 'active_record'
4
+ require 'has_logs/has_logs'
5
+ require 'has_logs/act_as_log'
6
+
7
+ module HasLogs
8
+ end
9
+
10
+ ActiveRecord::Base.include HasLogs::HasLogs
11
+ ActiveRecord::Base.include HasLogs::ActAsLog
metadata ADDED
@@ -0,0 +1,171 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: has_logs
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.5.0
5
+ platform: ruby
6
+ authors:
7
+ - isuke
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-07-25 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activesupport
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">"
18
+ - !ruby/object:Gem::Version
19
+ version: '3.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">"
25
+ - !ruby/object:Gem::Version
26
+ version: '3.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: activerecord
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">"
32
+ - !ruby/object:Gem::Version
33
+ version: '3.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">"
39
+ - !ruby/object:Gem::Version
40
+ version: '3.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.12'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.12'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec-its
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: shoulda
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: sqlite3
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '1.0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '1.0'
125
+ description: Logging your ActiveRecord model, and supply useful methods.
126
+ email:
127
+ - isuke770@gmail.com
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".gitignore"
133
+ - ".rspec"
134
+ - ".travis.yml"
135
+ - CODE_OF_CONDUCT.md
136
+ - Gemfile
137
+ - LICENSE.txt
138
+ - README.md
139
+ - Rakefile
140
+ - bin/console
141
+ - bin/setup
142
+ - has_logs.gemspec
143
+ - lib/has_logs.rb
144
+ - lib/has_logs/act_as_log.rb
145
+ - lib/has_logs/has_logs.rb
146
+ - lib/has_logs/version.rb
147
+ homepage: https://github.com/isuke/has_logs
148
+ licenses:
149
+ - MIT
150
+ metadata: {}
151
+ post_install_message:
152
+ rdoc_options: []
153
+ require_paths:
154
+ - lib
155
+ required_ruby_version: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ required_rubygems_version: !ruby/object:Gem::Requirement
161
+ requirements:
162
+ - - ">="
163
+ - !ruby/object:Gem::Version
164
+ version: '0'
165
+ requirements: []
166
+ rubyforge_project:
167
+ rubygems_version: 2.5.1
168
+ signing_key:
169
+ specification_version: 4
170
+ summary: Logging your ActiveRecord model.
171
+ test_files: []