cheesecloth 0.1.0

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "cheesecloth"
+
+# 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

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/cheesecloth.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cheesecloth/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cheesecloth"
+  spec.version       = CheeseCloth::VERSION
+  spec.authors       = ["Steven Petryk"]
+  spec.email         = ["me@stevenpetryk.com"]
+
+  spec.summary       = "Take the boilerplate out of filtering a collection based on params."
+  spec.description   = <<-DESCRIPTION
+    Dealing with filtering based on params in Rails APIs is a pain. CheeseCloth is designed to take
+    the pain out of parsing, validating, and acting upon params designed to filter collections.
+  DESCRIPTION
+  spec.homepage      = "https://github.com/stevenpetryk/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 "activesupport", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.3.1

data/lib/cheesecloth.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require "active_support"
+
+require_relative "cheesecloth/version"
+require_relative "cheesecloth/errors"
+require_relative "cheesecloth/filter"
+require_relative "cheesecloth/filter_list"
+require_relative "cheesecloth/wrapper"
+
+module CheeseCloth
+  extend ActiveSupport::Concern
+
+  included do
+    cattr_accessor :cheesecloth_wrapper
+    self.cheesecloth_wrapper = Wrapper.new(self)
+
+    attr_accessor :scope_override
+    attr_writer :scope
+  end
+
+  class_methods do
+    def scope(*args)
+      cheesecloth_wrapper.assign_default_scope_proc(*args)
+    end
+
+    def filter(conditions = nil, &block)
+      cheesecloth_wrapper.filter_list.add_filter(conditions, block)
+    end
+  end
+
+  def scope
+    @scope || scope_override || cheesecloth_wrapper.scope
+  end
+
+  def filtered_scope(scope: nil)
+    self.scope_override = scope
+    cheesecloth_wrapper.prepare_and_run(self)
+    self.scope
+  end
+
+  private
+
+  def cheesecloth_wrapper
+    self.class.cheesecloth_wrapper
+  end
+end

data/lib/cheesecloth/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CheeseCloth
+  class MissingScopeError < StandardError
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def message
+      <<-MSG.strip_heredoc
+        Was unable to determine the base scope. Perhaps you forgot to call `scope`?"
+
+        Try something like:
+
+        class #{@klass.name || 'FooFilterer'}
+          include CheeseCloth
+
+          scope -> { Model.all }
+        end
+      MSG
+    end
+  end
+end

data/lib/cheesecloth/filter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module CheeseCloth
+  class Filter
+    attr_reader :klass, :conditions, :block
+
+    def initialize(conditions, block)
+      @conditions = wrap(conditions)
+      @block = block
+    end
+
+    def run(instance)
+      instance.instance_eval(&block)
+    end
+
+    def conditions_satisfied?(instance)
+      conditions.all? { |condition| instance.send(condition) }
+    end
+
+    private
+
+    def wrap(possible_array)
+      [possible_array].flatten.compact
+    end
+  end
+end

data/lib/cheesecloth/filter_list.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module CheeseCloth
+  class FilterList
+    attr_reader :instance, :filters
+
+    def initialize(instance)
+      @instance = instance
+      @filters = []
+    end
+
+    def add_filter(conditions, block)
+      @filters << Filter.new(conditions, block)
+    end
+
+    def run_filters(instance)
+      runnable_filters_on(instance).each do |filter|
+        instance.scope = filter.run(instance)
+      end
+    end
+
+    private
+
+    def runnable_filters_on(instance)
+      filters.select { |filter| filter.conditions_satisfied?(instance) }
+    end
+  end
+end

data/lib/cheesecloth/version.rb

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

data/lib/cheesecloth/wrapper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module CheeseCloth
+  class Wrapper
+    attr_reader :klass, :filter_list, :scope, :default_scope_proc
+
+    def initialize(klass)
+      @klass = klass
+      @filter_list = FilterList.new(klass)
+    end
+
+    def assign_default_scope_proc(block)
+      @default_scope_proc = block
+    end
+
+    def prepare_and_run(instance)
+      assign_and_check_scope(instance)
+      run(instance)
+    end
+
+    def assign_and_check_scope(instance)
+      @scope ||= default_scope_proc && default_scope_proc.call
+      raise MissingScopeError, self.class unless instance.scope
+    end
+
+    def run(instance)
+      filter_list.run_filters(instance)
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: cheesecloth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steven Petryk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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'
+description: |2
+      Dealing with filtering based on params in Rails APIs is a pain. CheeseCloth is designed to take
+      the pain out of parsing, validating, and acting upon params designed to filter collections.
+email:
+- me@stevenpetryk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cheesecloth.gemspec
+- circle.yml
+- lib/cheesecloth.rb
+- lib/cheesecloth/errors.rb
+- lib/cheesecloth/filter.rb
+- lib/cheesecloth/filter_list.rb
+- lib/cheesecloth/version.rb
+- lib/cheesecloth/wrapper.rb
+homepage: https://github.com/stevenpetryk/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Take the boilerplate out of filtering a collection based on params.
+test_files: []