ar_memoization 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 2737c3dd29e321d958b4f5e07280b56f811559f039d638089dad14df0eab8188
4
+ data.tar.gz: b8fcbb969bfa0aed76999286cf6a5e536806a19e0b982ee4a9660f3e50bdd5a0
5
+ SHA512:
6
+ metadata.gz: b3aad8f7f25a062e47f7b7cc039ffe5f2236de2b7200c874a3adc118495dc27d516b0029155e420c06e18f44861522f782ff92b2c32f0828c34e834fe0c745f1
7
+ data.tar.gz: 1c3f26c3865dc0dd55a0c85622e708ecae71e1b5bd29fb8943978ff5e152e982dc3cf2b26b188be050abe449b237c5a3d84dff09ca8b6ae07b43eacee4c525e0
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 1.17.2
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at ysat.tap@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in ar_memoization.gemspec
6
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 ysat
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.
@@ -0,0 +1,46 @@
1
+ # ar_memoization
2
+ ArMemoization is a library for memoize ActiveRecord objects and search there.
3
+
4
+ This library has two modules.
5
+
6
+ * ArMemoization::PrimaryMethods
7
+ * ArMemoization::ForeignMethods
8
+
9
+ ```PrimaryMethods``` module contains methods to memoize Model instances.
10
+ This module is used for the Model of a table that hardly changes data.
11
+
12
+ ```ForeignMethods``` module contains methods that handle the memoized data of the Model using ```PrimaryMethods```.
13
+ This module is used in the Model that belongs_to the Model that uses ```PrimaryMethods```.
14
+
15
+ ## example
16
+
17
+ migration
18
+ ```ruby
19
+ class CreateAllTables < ActiveRecord::Migration[5.0]
20
+ def self.up
21
+ create_table(:countries) do |t|
22
+ t.string :name
23
+ end
24
+
25
+ create_table(:shops) do |t|
26
+ t.belongs_to :country
27
+ t.string :name
28
+ end
29
+ end
30
+ end
31
+ ```
32
+
33
+ app/models/country.rg
34
+ ```ruby
35
+ class Country < ActiveRecord::Base
36
+ extend ArMemoization::PrimaryMethods
37
+ end
38
+ ```
39
+
40
+ app/models/shop.rb
41
+ ```ruby
42
+ class Shop < ActiveRecord::Base
43
+ extend ArMemoization::ForeignMethods
44
+ belongs_to_memoized :country
45
+ end
46
+ ```
@@ -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
@@ -0,0 +1,33 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "ar_memoization/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "ar_memoization"
8
+ spec.version = ArMemoization::VERSION
9
+ spec.authors = ["Yoshihiro SATO"]
10
+ spec.email = ["ysat.tap@gmail.com"]
11
+
12
+ spec.summary = %q{Memoize ActiveRecord objects and search there.}
13
+ spec.homepage = "https://github.com/ysat/ar_memoization"
14
+ spec.license = "MIT"
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.required_ruby_version = ">= 1.9.2"
26
+
27
+ spec.add_dependency "activerecord", ">= 5.0"
28
+
29
+ spec.add_development_dependency "bundler", "~> 1.17"
30
+ spec.add_development_dependency "rake"
31
+ spec.add_development_dependency "rspec", "~> 3.0"
32
+ spec.add_development_dependency "sqlite3", "~> 1.0"
33
+ end
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "ar_memoization"
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(__FILE__)
@@ -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
@@ -0,0 +1,7 @@
1
+ require "ar_memoization/version"
2
+ require "ar_memoization/primary_methods"
3
+ require "ar_memoization/foreign_methods"
4
+ require "active_record"
5
+
6
+ module ArMemoization
7
+ end
@@ -0,0 +1,40 @@
1
+ module ArMemoization
2
+ module ForeignMethods
3
+ def belongs_to_memoized(association_name, scope = nil, **options)
4
+ belongs_to(association_name, scope, options)
5
+ reflection = reflect_on_association(association_name)
6
+
7
+ class_eval %Q{
8
+ def #{association_name}
9
+ unless association(:#{association_name}).target
10
+ obj = #{reflection.class_name}.find_memo(#{reflection.foreign_key})
11
+ association(:#{association_name}).writer(obj)
12
+ end
13
+ association(:#{association_name}).target
14
+ end
15
+ }
16
+ end
17
+
18
+ # def has_one_memoized(association_name, scope = nil, **options)
19
+ # end
20
+
21
+ # def has_many_memoized(association_name, scope = nil, **options, &extension)
22
+ # end
23
+
24
+ def where_memoized(association_name, method_name = nil, &block)
25
+ reflection = reflect_on_association(association_name)
26
+ memos = reflection.class_name.constantize.all_memos
27
+
28
+ foreign_keys = case
29
+ when method_name
30
+ memos.select(&method_name)
31
+ when block_given?
32
+ memos.select(&block)
33
+ else
34
+ []
35
+ end.map(&:id)
36
+
37
+ where(reflection.foreign_key => foreign_keys)
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,31 @@
1
+ module ArMemoization
2
+ module PrimaryMethods
3
+ def find_memo(ident)
4
+ ar_memoization_memoized_table[ident.to_i]
5
+ end
6
+
7
+ def detect_memo(&block)
8
+ all_memos.detect(&block)
9
+ end
10
+
11
+ def select_memos(&block)
12
+ all_memos.select(&block)
13
+ end
14
+
15
+ def all_memos
16
+ ar_memoization_memoized_table.values
17
+ end
18
+
19
+ def reload_memos
20
+ ar_memoization_memoized_table(reload: true)
21
+ all_memos
22
+ end
23
+
24
+ def ar_memoization_memoized_table(reload: false)
25
+ if reload || @ar_memoization_memoized_table.nil?
26
+ @ar_memoization_memoized_table = all.index_by(&:id)
27
+ end
28
+ @ar_memoization_memoized_table
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,3 @@
1
+ module ArMemoization
2
+ VERSION = "0.1.1"
3
+ end
metadata ADDED
@@ -0,0 +1,128 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ar_memoization
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Yoshihiro SATO
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-12-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activerecord
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '5.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '5.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.17'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.17'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: sqlite3
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.0'
83
+ description:
84
+ email:
85
+ - ysat.tap@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - ar_memoization.gemspec
99
+ - bin/console
100
+ - bin/setup
101
+ - lib/ar_memoization.rb
102
+ - lib/ar_memoization/foreign_methods.rb
103
+ - lib/ar_memoization/primary_methods.rb
104
+ - lib/ar_memoization/version.rb
105
+ homepage: https://github.com/ysat/ar_memoization
106
+ licenses:
107
+ - MIT
108
+ metadata: {}
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: 1.9.2
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubygems_version: 3.0.3
125
+ signing_key:
126
+ specification_version: 4
127
+ summary: Memoize ActiveRecord objects and search there.
128
+ test_files: []