snfoil 0.1.0

data/lib/sn_foil/searcher.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module SnFoil
+  module Searcher
+    extend ActiveSupport::Concern
+
+    included do
+      TRUECAST = 'true'
+      FALSECAST = 'false'
+    end
+
+    class_methods do
+      attr_reader :i_model, :i_setup, :i_filters, :i_search_step
+
+      def model(klass = nil)
+        @i_model = klass
+      end
+
+      def setup(setup_method = nil, &setup_block)
+        @i_setup = setup_method || setup_block
+      end
+
+      def filter(method = nil, **options, &block)
+        raise ArgumentError, 'filter requires either a method name or a block' if method.nil? && block.nil?
+
+        (@i_filters ||= []) << {
+          method: method,
+          block: block,
+          if: options[:if],
+          unless: options[:unless]
+        }
+      end
+    end
+
+    def model
+      self.class.i_model
+    end
+
+    attr_reader :scope
+    def initialize(scope: nil)
+      @scope = scope || model.all
+    end
+
+    def search(params = {})
+      params = transform_params_booleans(params) # this is required for params coming in from http-like sources
+      filtered_scope = filter || scope # start usimg the default scope of the class or the filter method
+      filtered_scope = apply_setup(filtered_scope, params)
+      apply_filters(filtered_scope, params)
+    end
+
+    def filter; end
+
+    def setup
+      self.class.i_setup
+    end
+
+    def filters
+      self.class.i_filters || []
+    end
+
+    private
+
+    def apply_setup(filtered_scope, params)
+      return filtered_scope if setup.nil?
+
+      if setup.is_a?(Symbol) || setup.is_a?(String)
+        send(setup, filtered_scope, params)
+      else
+        setup.call(filtered_scope, params)
+      end
+    end
+
+    def apply_filters(filtered_scope, params)
+      filters&.reduce(filtered_scope) do |i_scope, i_filter|
+        apply_filter(i_filter, i_scope, params)
+      end
+    end
+
+    def apply_filter(i_filter, filtered_scope, params)
+      return filtered_scope unless filter_valid?(i_filter, params)
+
+      return send(i_filter[:method], filtered_scope, params) if i_filter[:method]
+
+      i_filter[:block].call(filtered_scope, params)
+    end
+
+    def filter_valid?(i_filter, params)
+      return false if !i_filter[:if].nil? && i_filter[:if].call(params) == false
+      return false if !i_filter[:unless].nil? && i_filter[:unless].call(params) == true
+
+      true
+    end
+
+    def transform_params_booleans(params)
+      params.map do |key, value|
+        value = if value == TRUECAST
+                  true
+                elsif value == FALSECAST
+                  false
+                else
+                  value
+                end
+        [key, value]
+      end.to_h
+    end
+  end
+end

data/lib/sn_foil/version.rb

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

data/lib/sn_foil.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'sn_foil/context'
+require 'sn_foil/policy'
+require 'sn_foil/searcher'
+require 'sn_foil/version'
+
+module SnFoil
+  class Error < StandardError; end
+
+  mattr_accessor :orm, default: 'active_record'
+  mattr_writer :logger
+
+  class << self
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = name
+      end
+    end
+
+    def adapter
+      return @adapter if @adapter
+
+      @adapter ||= if orm.instance_of?(String) || orm.instance_of?(Symbol)
+                     if Object.const_defined?("SnFoil::Adapters::ORMs::#{orm.camelcase}")
+                       "SnFoil::Adapters::ORMs::#{orm.camelcase}".constantize
+                     else
+                       orm.constantize
+                     end
+                   else
+                     orm
+                   end
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/snfoil.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sn_foil/version'
+
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = 'snfoil'
+  spec.version       = SnFoil::VERSION
+  spec.authors     = ['Matthew Howes', 'Danny Murphy']
+  spec.email       = ['howeszy@gmail.com', 'dmurph24@gmail.com']
+  spec.summary       = 'A boilerplate gem for providing basic contexts'
+  spec.homepage      = 'https://github.com/howeszy/snfoil'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) 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 'activesupport', '>= 5.1'
+  spec.add_dependency 'logger', '~> 1.0'
+  spec.add_dependency 'pundit', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.76.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.36.0'
+  spec.add_development_dependency 'dry-struct', '~> 1.0'
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: snfoil
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Howes
+- Danny Murphy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- howeszy@gmail.com
+- dmurph24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sn_foil.rb
+- lib/sn_foil/adapters/orms/active_record.rb
+- lib/sn_foil/adapters/orms/base_adapter.rb
+- lib/sn_foil/context.rb
+- lib/sn_foil/contexts/build_context_concern.rb
+- lib/sn_foil/contexts/change_context_concern.rb
+- lib/sn_foil/contexts/create_context_concern.rb
+- lib/sn_foil/contexts/destroy_context_concern.rb
+- lib/sn_foil/contexts/index_context_concern.rb
+- lib/sn_foil/contexts/setup_context_concern.rb
+- lib/sn_foil/contexts/show_context_concern.rb
+- lib/sn_foil/contexts/update_context_concern.rb
+- lib/sn_foil/policy.rb
+- lib/sn_foil/searcher.rb
+- lib/sn_foil/version.rb
+- snfoil.gemspec
+homepage: https://github.com/howeszy/snfoil
+licenses:
+- MIT
+metadata: {}
+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: A boilerplate gem for providing basic contexts
+test_files: []