findit 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa72800635cdabfff2a7363ba8525315b782e37e
-  data.tar.gz: 05667fd93e82d9352acc0f9f1e97704fd48b3fb4
+  metadata.gz: 4f2a7acc1f32c6584aecb5515f041e81bd2410ee
+  data.tar.gz: 6549ea60916596d9fde883fe75c0ebefca715438
 SHA512:
-  metadata.gz: 069e2eaea3e6c393ab2d29fdba362bd4b7a34231f141f93cebceb4be85bdc1ecdda5877a48ea5a99c236ed932be92d845919785c9f6d68d7556ba219f18a86ea
-  data.tar.gz: fc4ba671c1af2282bac7ec289d7da2e868ca8f721b4cec0c937c5c1a61665322efd4ff02fe20a1ec716a1e4eb8d16cf05d2d7e583c27dc4600736fb6c450bef0
+  metadata.gz: e3b50f8a45783e0c2d873700c22367d0c38f28d1cb14c05615c94c1d637c287d0b4bfdbdbedb1e03d1032089742cca46bcafb6d9a327f142d46b09772328f98b
+  data.tar.gz: 4c1a5cead6328b4494646e6c91d81ce1c61c89a20ea55e3b9dbfc84fc89cfa192202336117b53e15c179bb3421c3e5e6a2471ccbe69d0e8ac174609967833753

data/.drone.yml

@@ -0,0 +1,19 @@
+build:
+  test:
+    image: abakpress/dind-testing
+    pull: true
+    privileged: true
+    volumes:
+      - /home/data/drone/images:/images
+      - /home/data/drone/gems:/bundle
+    environment:
+      - COMPOSE_FILE_EXT=drone
+      - RUBY_IMAGE_TAG=2.2-latest
+    commands:
+      - wrapdocker docker -v
+
+      - fetch-images
+        --image abakpress/ruby-app:$RUBY_IMAGE_TAG
+
+      - dip provision
+      - dip rspec

data/README.md

@@ -160,7 +160,7 @@ end
    <%=render 'post', collection: @posts, as: :post%> # it will automaticly iterate over finder results by each method
 ```
 
-## WillPaginate
+### WillPaginate
 
 It adds delegation of [will_paginate](https://github.com/mislav/will_paginate) methods to finder.
 
@@ -202,6 +202,85 @@ end
   <%= will_paginate @posts %>
 ```
 
+### Single
+
+Adds DSL for cache_key on Finder with single element to find.
+
+Example usage:
+
+```ruby
+# app/finders/post_finder.rb
+class PostsFinder
+  include Findit::Single
+
+  cache_key do
+    @user
+  end
+
+  def initialize(user)
+    @user = user
+  end
+
+  private
+
+  def find
+    Post.where(user: user).last
+  end
+end
+```
+
+### Cache
+
+Extends finder with cache possibility. Every call of `call` method will be cached in `Rails.cache`.
+Method `cache options` allows you to add custom options like `expire_in` or `tags` to `Rails.cache.fetch`.
+If you want to disable cache dependent of initialization arguments, you can use `cache?` DSL method.
+
+All in one Example:
+```ruby
+# app/finders/post_finder.rb
+class CachedPostsFinder
+  include Findit::Single
+  include Findit::Cache
+
+  cache_key do
+    @user
+  end
+
+  cache_options do
+    {expire_in: 15.minutes} # This will be directly passed to Rails.cache.fetch
+  end
+
+  def initialize(user)
+    @user = user
+  end
+
+  private
+
+  def find
+    Post.where(user: user)
+  end
+end
+```
+
+To disable cache for some reasone you can call special method without_cache:
+
+```ruby
+CachedFinder.new(user).without_cache.load # no cache
+
+CachedFinder.new(user).load - # will perform cache operations
+```
+
+
+If you want this functionality on Collections finder you can add extension `Findit::Collections` alongside with Cache:
+```ruby
+class SomeFinder
+  include Findit::Collections
+  include Findit::Cache
+
+  ...
+end
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/findit.
+Bug reports and pull requests are welcome on GitHub at https://github.com/abak-press/findit.

data/dip.yml

@@ -0,0 +1,46 @@
+version: '1'
+
+environment:
+  DOCKER_RUBY_VERSION: 2.2
+  RUBY_IMAGE_TAG: 2.2-latest
+  COMPOSE_FILE_EXT: development
+  RAILS_ENV: test
+
+compose:
+  files:
+    - docker-compose.yml
+    - docker-compose.${COMPOSE_FILE_EXT}.yml
+
+interaction:
+  sh:
+    service: app
+
+  irb:
+    service: app
+    command: irb
+
+  bundle:
+    service: app
+    command: bundle
+
+  rake:
+    service: app
+    command: bundle exec rake
+
+  appraisal:
+    service: app
+    command: bundle exec appraisal
+
+  rspec:
+    service: app
+    command: bundle exec appraisal bundle exec rspec
+
+  clean:
+    service: app
+    command: rm -f Gemfile.lock gemfiles/*.gemfile.*
+
+provision:
+  - docker volume create --name bundler_data
+  - dip clean
+  - dip bundle install
+  - dip appraisal install

data/docker-compose.development.yml

@@ -0,0 +1,12 @@
+version: '2'
+
+services:
+  app:
+    volumes:
+      - .:/app
+      - bundler-data:/bundle
+
+volumes:
+  bundler-data:
+    external:
+      name: bundler_data

data/docker-compose.drone.yml

@@ -0,0 +1,7 @@
+version: '2'
+
+services:
+  app:
+    volumes:
+      - .:/app
+      - /bundle:/bundle

data/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '2'
+
+services:
+  app:
+    image: abakpress/ruby-app:$RUBY_IMAGE_TAG
+    environment:
+      - BUNDLE_PATH=/bundle/$DOCKER_RUBY_VERSION
+      - BUNDLE_CONFIG=/app/.bundle/config
+    command: bash

data/findit.gemspec

@@ -25,8 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-rails", ">= 3.2"
   spec.add_development_dependency 'combustion', '>= 0.5'
   spec.add_development_dependency "appraisal", ">= 2.1.0"
-  spec.add_development_dependency 'pry-debugger'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'shoulda-matchers', '< 3.0.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'test-unit'
 end

data/lib/findit/cache.rb

@@ -0,0 +1,87 @@
+#
+#  Example usage:
+#
+#  #/app/finders/posts_finders.rb
+#  class CachedPostFinder
+#    include Findit::Cache
+#
+#    cache_key do
+#      [@user.id, @query]
+#    end
+#
+#    cache? do
+#      !@no_cache
+#    end
+#
+#    cache_options do
+#      {expire_in: 15.minutes}
+#    end
+#
+#    private
+#
+#    def find
+#      scope = scope.where(user_id: @user.id)
+#      scope = scope.where('description like :query', query: @query) if @query.present?
+#      scope
+#    end
+#  end
+#
+#  #/app/controllers/posts_controller.rb
+#  class PostsController < ApplicationController
+#    def show
+#      @post = CachedPostFinder.new(user: current_user).call
+#    end
+#  end
+#
+#  #/app/views/posts/index.html.erb
+#  # Already cached in finder itself
+#  <%= render 'post', post: @post%>
+#
+#  # OR if you call it in another finder
+#  class CommentOnMyLastPostFinder
+#    include Findit::Collections
+#
+#    def initialize(user)
+#      @user = user
+#    end
+#
+#    private
+#
+#    def find
+#      last_post.comments
+#    end
+#
+#    def last_post
+#      @post = CachedPostFinder.new(user).call
+#    end
+#  end
+#
+module Findit
+  module Cache
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def cache_options(&block)
+        define_method(:cache_options) do
+          instance_exec(&block)
+        end
+      end
+    end
+
+    included do
+      set_callback :find, :around do |object, block|
+        if !defined?(@cache) || @cache
+          options = respond_to?(:cache_options) && cache_options
+          @data = Rails.cache.fetch(object.cache_key, options) { block.call }
+        else
+          block.call
+        end
+      end
+    end
+
+    def without_cache
+      @cache = false
+      self
+    end
+  end
+end

data/lib/findit/collections.rb

@@ -40,24 +40,8 @@ module Findit
     extend ActiveSupport::Concern
 
     included do
+      include ::Findit::Single
       delegate :each, :[], :size, :empty?, :to_ary, :to_a, to: :call
     end
-
-    module ClassMethods
-      def cache_key(&block)
-        define_method :cache_key do
-          @cache_key ||= ActiveSupport::Cache.expand_cache_key(instance_exec(&block), self.class.name.underscore)
-        end
-      end
-    end
-
-    def find
-    end
-    undef :find
-
-    def call
-      return @data if defined?(@data)
-      @data = find
-    end
   end
 end

data/lib/findit/single.rb

@@ -0,0 +1,63 @@
+#
+#  Example usage:
+#
+#  #/app/finders/post_finders.rb
+#  class PostFinder
+#    include Findit::Single
+#
+#    cache_key do
+#      [@user.id, @query]
+#    end
+#
+#    def initialize(user, options = {})
+#      @user = user
+#      @query = options.fetch(:query)
+#    end
+#
+#    private
+#
+#    def find
+#      post = scope.find_by('description like :query', query: @query)
+#    end
+#  end
+#
+#  #/app/controllers/posts_controller.rb
+#  class PostsController < ApplicationController
+#    def show
+#      @post = PostFinder.new(current_user, query: 'some desc')
+#    end
+#  end
+#
+#  #/app/views/posts/show.html.erb
+#  <% cache(@post, expire_in: 15.minutes) do %>
+#    <%= render 'post', post: @post.load%>
+#
+module Findit
+  module Single
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveSupport::Callbacks
+      define_callbacks :find
+    end
+
+    module ClassMethods
+      def cache_key(&block)
+        define_method :cache_key do
+          @cache_key ||= ActiveSupport::Cache.expand_cache_key(instance_exec(&block), self.class.name.underscore)
+        end
+      end
+    end
+
+    def find
+    end
+    undef :find
+
+    def call
+      return @data if defined?(@data)
+      res = run_callbacks(:find) { find }
+      @data ||= res
+    end
+    alias_method :load, :call
+  end
+end

data/lib/findit/version.rb

@@ -1,3 +1,3 @@
 module Findit
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/findit.rb

@@ -1,5 +1,7 @@
 require 'active_support'
 require "findit/version"
+require 'findit/single'
+require 'findit/cache'
 require 'findit/collections'
 require 'findit/will_paginate'
 

metadata

@@ -1,169 +1,183 @@
 --- !ruby/object:Gem::Specification
 name: findit
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Denis Korobicyn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.1'
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.1'
+- !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.2'
+- !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0.5'
+- !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  name: pry-debugger
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
   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: '0'
   type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: 
 email:
 - deniskorobitcin@gmail.com
@@ -171,18 +185,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".drone.yml"
+- ".gitignore"
 - Appraisals
 - Gemfile
-- Makefile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - config.ru
+- dip.yml
+- docker-compose.development.yml
+- docker-compose.drone.yml
+- docker-compose.yml
 - findit.gemspec
 - lib/findit.rb
+- lib/findit/cache.rb
 - lib/findit/collections.rb
+- lib/findit/single.rb
 - lib/findit/version.rb
 - lib/findit/will_paginate.rb
 homepage: https://github.com/abak-press/findit
@@ -194,17 +214,17 @@ 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.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Extensions for Finder classes

data/Makefile

@@ -1,23 +0,0 @@
-RAILS_ENV = test
-BUNDLE_VERSION = 1.11.2
-BUNDLE = RAILS_ENV=${RAILS_ENV} bundle _${BUNDLE_VERSION}_
-BUNDLE_OPTIONS = -j 2
-RSPEC = rspec
-APPRAISAL = appraisal
-
-all: test
-
-test: bundler/install appraisal/install
-	${BUNDLE} exec ${APPRAISAL} ${RSPEC} spec 2>&1
-
-bundler/install:
-	gem install bundler --version=${BUNDLE_VERSION};
-	${BUNDLE} install ${BUNDLE_OPTIONS}
-
-appraisal/install:
-	${BUNDLE} exec ${APPRAISAL} install
-
-clean:
-	rm -f Gemfile.lock
-	rm -rf gemfiles
-