hario 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 314a179b80afaf6621fc5fd75b8ac07f9b666e83
+  data.tar.gz: 66974a51f922f7141e76032957f94bc671c98a34
+SHA512:
+  metadata.gz: e7374fc27c93e5d1eb848a1b955919f9b938913a0120277a58e10a33b7d9fa7bed23faf0f57cf2ba8e37794cb549606629d9b0285c7d4570ab40413799180c01
+  data.tar.gz: 0fdc5240d5b1959848b1b76280cdd97219493d639a22bcf735fa1207acd0d4e1ef0178945b9d0637be46a808d0107f5bd2c23a49cc7c92d02e4f027313b4f949

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mike Campbell
+
+MIT License
+
+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,33 @@
+# Hario
+
+Hario provides ActiveRecord filtering for Rails APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hario'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hario
+
+## Usage
+
+```ruby
+def Animal < ActiveRecord::Base
+  include Hario::Filterable
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hario/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs = ["lib"]
+  t.warning = true
+  t.verbose = true
+  t.test_files = FileList['test/*_test.rb']
+end

data/hario.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hario/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hario"
+  spec.version       = Hario::VERSION
+  spec.authors       = ["Mike Campbell"]
+  spec.email         = ["mike@wordofmike.net"]
+  spec.summary       = %q{Hario provides ActiveRecord filtering for Rails APIs.}
+  spec.homepage      = "https://github.com/meritec/hario"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "sqlite3", "~> 0"
+end

data/lib/hario/behaviours/filter.rb

@@ -0,0 +1,57 @@
+require "hario/behaviours/utils"
+
+class FilterParser
+  include ParserUtils
+
+  OPERATORS = { lt: '<', gt: '>', lte: '<=', gte: '>=', like: 'like', equals: '=' }
+
+  attr_accessor :join_clause, :where_clauses
+
+  def initialize(filters, klass)
+    @filters = filters
+    @klass = klass
+
+    parse_filters
+  end
+
+  private
+    def parse_filters
+      @join_clause, @where_clauses = @filters.inject([{}, []]) do |m, (descriptor, value)|
+        association_chain, attribute, operator = parse_descriptor(descriptor)
+        condition = build_condition(association_chain, attribute, operator, value)
+
+        nested_associations = (association_chain << {}).reverse.inject { |v, key| { key => v } }
+        joins = m[0].deep_merge(nested_associations)
+        wheres = m[1] + [condition]
+        [joins, wheres]
+      end
+    end
+
+    def parse_descriptor(descriptor)
+      parts = descriptor.split('.')
+      operator = parts.pop.to_sym
+      attribute = parts.pop
+      association_chain = parts
+
+      [association_chain, attribute, operator]
+    end
+
+    def build_condition(association_chain, attribute, operator, value)
+      if association_chain.any?
+        attribute_table = table_name_from_association_chain(association_chain)
+      end
+
+      case operator
+      when :equals
+        condition = { attribute => value }
+        condition = { attribute_table => condition } if attribute_table
+      else
+        value = "%#{value}%" if operator == :like
+        operator = OPERATORS[operator]
+        condition = ["? #{operator} ?", attribute, value]
+        condition[1].prepend("#{attribute_table}.") if attribute_table
+      end
+
+      condition
+    end
+end

data/lib/hario/behaviours/pluck.rb

@@ -0,0 +1,42 @@
+require "hario/behaviours/utils"
+
+class PluckParser
+  include ParserUtils
+
+  attr_accessor :join_clause, :pluck_clause
+
+  def initialize(pluck, klass)
+    @pluck = pluck
+    @klass = klass
+
+    parse_pluck
+  end
+
+  private
+    def parse_pluck
+      @join_clause = {}
+      @pluck_clause = [[@klass.table_name, 'id'].join('.')]
+
+      ns, no_ns = @pluck.partition{ |p| p.include?('.') }
+
+      no_ns.each{ |p| @pluck_clause << [@klass.table_name, p].join('.') }
+
+      ns.each do |p|
+        association_chain, attribute = parse_namespace(p)
+
+        nested_associations = (association_chain << {}).reverse.inject { |v, key| { key => v } }
+        @join_clause.deep_merge!(nested_associations)
+
+        attribute_table = table_name_from_association_chain(association_chain)
+        @pluck_clause << [attribute_table, attribute].join('.')
+      end
+    end
+
+    def parse_namespace(namespace)
+      parts = namespace.split('.')
+      attribute = parts.pop
+      association_chain = parts
+      
+      [association_chain, attribute]
+    end
+end

data/lib/hario/behaviours/utils.rb

@@ -0,0 +1,11 @@
+module ParserUtils
+  def table_name_from_association_chain(association_chain)
+    head = @klass
+
+    association_chain.each do |a_name|
+      head = head.reflect_on_all_associations.find{ |a| a.name.to_s == a_name }.klass
+    end
+    
+    head.table_name
+  end
+end

data/lib/hario/version.rb

@@ -0,0 +1,3 @@
+module Hario
+  VERSION = "0.1.0"
+end

data/lib/hario.rb

@@ -0,0 +1,36 @@
+require "hario/version"
+require "hario/behaviours/filter"
+require "hario/behaviours/pluck"
+
+module Hario
+  module Filterable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def search(filters, pluck = nil)
+        s = all
+        s = s.apply_filters(filters) if filters
+        s = s.apply_pluck(pluck) if pluck
+        s
+      end
+
+      def apply_filters(filters)
+        fp = FilterParser.new(filters, self)
+
+        fp.where_clauses.reduce(joins(fp.join_clause), &:where)
+      end
+
+      def apply_pluck(pluck)
+        pp = PluckParser.new(pluck, self)
+
+        results = hash_pluck(*pp.pluck_clause)
+
+        remove_local_table_prefix(results)
+      end
+
+      def remove_local_table_prefix(results)
+        results.map{ |r| r.transform_keys!{ |k| k.gsub(/^#{table_name}\./, '') } }
+      end
+    end
+  end
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3 
+  database: ":memory:"

data/test/debug.log

@@ -0,0 +1,16 @@
+# Logfile created on 2015-06-25 23:10:26 +0100 by logger.rb/44203
+D, [2015-06-25T23:10:27.058465 #74888] DEBUG -- :    (0.1ms)  begin transaction
+D, [2015-06-25T23:10:27.088174 #74888] DEBUG -- :   SQL (0.2ms)  INSERT INTO "brands" ("name") VALUES (?)  [["name", "Adidas"]]
+D, [2015-06-25T23:10:27.104100 #74888] DEBUG -- :    (0.2ms)  commit transaction
+D, [2015-06-25T23:10:27.127906 #74888] DEBUG -- :   Brand Load (0.2ms)  SELECT "brands".* FROM "brands" WHERE "brands"."name" = ?  [["name", "Adidas"]]
+D, [2015-06-25T23:10:27.145343 #74888] DEBUG -- :   SQL (15.2ms)  DELETE FROM "brands"
+D, [2015-06-25T23:11:17.882386 #74899] DEBUG -- :    (0.1ms)  begin transaction
+D, [2015-06-25T23:11:17.912442 #74899] DEBUG -- :   SQL (0.3ms)  INSERT INTO "brands" ("name") VALUES (?)  [["name", "Adidas"]]
+D, [2015-06-25T23:11:17.913038 #74899] DEBUG -- :    (0.1ms)  commit transaction
+D, [2015-06-25T23:11:17.939361 #74899] DEBUG -- :   Brand Load (0.2ms)  SELECT "brands".* FROM "brands" WHERE "brands"."name" = ?  [["name", "Adidas"]]
+D, [2015-06-25T23:11:17.941683 #74899] DEBUG -- :   SQL (0.1ms)  DELETE FROM "brands"
+D, [2015-06-25T23:11:27.792300 #74906] DEBUG -- :    (0.1ms)  begin transaction
+D, [2015-06-25T23:11:27.857213 #74906] DEBUG -- :   SQL (0.2ms)  INSERT INTO "brands" ("name") VALUES (?)  [["name", "Adidas"]]
+D, [2015-06-25T23:11:27.857824 #74906] DEBUG -- :    (0.1ms)  commit transaction
+D, [2015-06-25T23:11:27.885282 #74906] DEBUG -- :   Brand Load (0.2ms)  SELECT "brands".* FROM "brands" WHERE "brands"."name" = ?  [["name", "Adidas"]]
+D, [2015-06-25T23:11:27.887789 #74906] DEBUG -- :   SQL (0.1ms)  DELETE FROM "brands"

data/test/filter_test.rb

@@ -0,0 +1,19 @@
+require 'minitest/autorun'
+require_relative 'test_helper'
+
+class FilterTest < Minitest::Test
+  def setup
+    @brand = Brand.create!(name: "Adidas")
+  end
+
+  def teardown
+    Brand.delete_all
+  end
+
+  def test_simple_filter
+    filters = { 'name.equals' => "Adidas" }
+    brands = Brand.search(filters)
+
+    assert !brands.any?{|b| b.name != "Adidas" }
+  end
+end

data/test/models.rb

@@ -0,0 +1,5 @@
+require 'hario'
+
+class Brand < ActiveRecord::Base
+  include Hario::Filterable
+end

data/test/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :brands, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :products, :force => true do |t|
+    t.column :name, :string
+    t.column :product_category_id, :integer
+    t.column :brand_id, :integer
+  end
+
+  create_table :product_categories, :force => true do |t|
+    t.column :name, :string
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "active_record"
+require "hario"
+require "models"
+
+ActiveRecord::Base.configurations = YAML.load_file(File.join(File.dirname(__FILE__), 'database.yml'))
+ActiveRecord::Base.establish_connection(ENV['DB'] || :sqlite3)
+load(File.join(File.dirname(__FILE__), "/schema.rb"))
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: hario
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: 
+email:
+- mike@wordofmike.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hario.gemspec
+- lib/hario.rb
+- lib/hario/behaviours/filter.rb
+- lib/hario/behaviours/pluck.rb
+- lib/hario/behaviours/utils.rb
+- lib/hario/version.rb
+- test/database.yml
+- test/debug.log
+- test/filter_test.rb
+- test/models.rb
+- test/pluck_test.rb
+- test/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/meritec/hario
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Hario provides ActiveRecord filtering for Rails APIs.
+test_files:
+- test/database.yml
+- test/debug.log
+- test/filter_test.rb
+- test/models.rb
+- test/pluck_test.rb
+- test/schema.rb
+- test/test_helper.rb