active_record_lazy_find_by 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 127922e548cd9fc4c6fa76d3227772f0798794fa3be2340387fce0cadda5fd67
+  data.tar.gz: c62e1e674ac0208b58165e40eccf4c54073eafa02c8a451bd30dd5419d693968
+SHA512:
+  metadata.gz: 56b068ee06ee21e0f8783c3fa29f2aafc1cb4c88207d6cf4e0d849104d0de50048fc8082e7806d60ae30446124201560b460e47e965099fc272be128fb7236cb
+  data.tar.gz: 3359d228bbd46e77a3fb1117f24d34a85aec392813a7db75cd6c48b724b1438db0573b24712f4149c843c989bec200e9c315408fe87ab152a4988aefbfe6726d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+language: ruby
+
+rvm:
+  - 2.5
+  - 2.6
+  - ruby-head
+
+gemfile:
+  - gemfiles/activerecord_52.gemfile
+  - gemfiles/activerecord_60.gemfile
+  - gemfiles/activerecord_edge.gemfile
+
+before_install:
+  - gem update --system
+  - gem update bundler
+
+cache: bundler
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - gemfile: gemfiles/activerecord_edge.gemfile

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sinsoku.listy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 sinsoku
+
+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,104 @@
+[![Build Status](https://travis-ci.org/sinsoku/active_record_lazy_find_by.svg?branch=master)](https://travis-ci.org/sinsoku/active_record_lazy_find_by)
+
+# ActiveRecordLazyFindBy
+
+`ActiveRecordLazyFindBy` provides simple lazy methods that be able to reduce SQL issuance slightly.
+
+## :package: Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_lazy_find_by'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_lazy_find_by
+
+## :memo: Usage
+
+For example, you have defined the following table and class:
+
+```ruby
+# == Schema Information
+#
+# Table name: users
+#
+#  id         :integer          not null, primary key
+#  name       :string           not null
+#  age        :integer          not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+class User < ApplicationRecord
+  include ActiveRecordLazyFindBy::Methods
+
+  has_many :posts
+end
+```
+
+The `lazy_find_by` returns an instance that does not execute SQL until it is needed.
+
+```ruby
+user = User.lazy_find_by(id: 1, name: "foo")
+#=> #<User id: 1, name: "foo", age: nil, created_at: nil, updated_at: nil>
+user.id
+#=> 1
+user.name
+#=> "foo"
+user.age
+  User Load (0.4ms)  SELECT "users".* FROM "users" WHERE "users"."id" = ? LIMIT ?  [["id", 1], ["LIMIT", 1]]
+#=> 39
+```
+
+### :+1: Find by relations
+
+It executes SQL for relations, but it does not execute SQL for `users` table.
+
+```ruby
+user = User.lazy_find_by(id: 1, name: "foo")
+user.posts.find_by(id: 1)
+  Post Load (0.3ms)  SELECT "posts".* FROM "posts" WHERE "posts"."user_id" = ? AND "posts"."id" = ? LIMIT ?  [["user_id", 1], ["id", 1], ["LIMIT", 1]]
+#=> #<Post id: 1, user_id: 1, title: "bar", created_at: "2019-05-10 15:44:39", updated_at: "2019-05-10 15:44:39">
+```
+
+### :green_heart: Pass only `id` attribute
+
+This gem provides the `lazy_find` method that be able to pass only `id` attribute.
+
+```ruby
+user = User.lazy_find(1)
+user.id
+#=> 1
+user.name
+  User Load (0.4ms)  SELECT "users".* FROM "users" WHERE "users"."id" = ? LIMIT ?  [["id", 1], ["LIMIT", 1]]
+#=> "dhh"
+```
+
+## :warning: Caution
+
+`lazy_find_by` and `lazy_find` methods does not execute SQL immediately, so an instance that returns by these methods may be older than databases.
+
+## 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/sinsoku/active_record_lazy_find_by. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveRecordLazyFindBy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_record_lazy_find_by/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/active_record_lazy_find_by.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record_lazy_find_by/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_lazy_find_by"
+  spec.version       = ActiveRecordLazyFindBy::VERSION
+  spec.authors       = ["sinsoku"]
+  spec.email         = ["sinsoku.listy@gmail.com"]
+
+  spec.summary       = "It provides a simple method to make SQL execution lazy."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/sinsoku/active_record_lazy_find_by"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 5.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_lazy_find_by"
+
+# 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(__FILE__)

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/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "4"

data/gemfiles/activerecord_52.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+
+gemspec path: ".."

data/gemfiles/activerecord_60.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0.rc1"
+
+gemspec path: ".."

data/gemfiles/activerecord_edge.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+github "rails/rails" do
+  gem "activerecord"
+end
+
+gemspec path: ".."

data/lib/active_record_lazy_find_by.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "active_record_lazy_find_by/version"
+
+module ActiveRecordLazyFindBy
+  STATE_METHOD_NAMES = %i[valid? new_record? persisted?].freeze
+
+  class << self
+    def module_for(klass, attributes)
+      lazy_attr_names = (klass.attribute_names - attributes.keys.map(&:to_s)).sort
+      key = [klass, lazy_attr_names]
+
+      cache[key] ||= build(lazy_attr_names)
+    end
+
+    def cache
+      @cache ||= {}
+    end
+
+    private
+
+    def build(attr_names)
+      lazy_method_names = attr_names.flat_map { |x| [x, "#{x}?", "#{x}="] } + STATE_METHOD_NAMES
+
+      Module.new do
+        lazy_method_names.each do |m|
+          define_method(m) do |*args|
+            unless @lazy_new_record
+              @lazy_new_record = true
+              reload
+            end
+            super(*args)
+          end
+        end
+      end
+    end
+  end
+
+  module Methods
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def lazy_find_by(attributes = {})
+        mod = ActiveRecordLazyFindBy.module_for(self, attributes)
+        new(attributes).extend(mod)
+      end
+
+      def lazy_find(id)
+        lazy_find_by(id: id)
+      end
+    end
+  end
+end

data/lib/active_record_lazy_find_by/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordLazyFindBy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: active_record_lazy_find_by
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sinsoku
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: sqlite3
+  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: It provides a simple method to make SQL execution lazy.
+email:
+- sinsoku.listy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_lazy_find_by.gemspec
+- bin/console
+- bin/setup
+- gemfiles/.bundle/config
+- gemfiles/activerecord_52.gemfile
+- gemfiles/activerecord_60.gemfile
+- gemfiles/activerecord_edge.gemfile
+- lib/active_record_lazy_find_by.rb
+- lib/active_record_lazy_find_by/version.rb
+homepage: https://github.com/sinsoku/active_record_lazy_find_by
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sinsoku/active_record_lazy_find_by
+  source_code_uri: https://github.com/sinsoku/active_record_lazy_find_by
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: It provides a simple method to make SQL execution lazy.
+test_files: []