showcase_filter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9efe3a7eae6a21bc263f7bc758aa8de6b11c275
+  data.tar.gz: e464717f66488bf624ba072bff344d28da6f012a
+SHA512:
+  metadata.gz: 032dd8b2f033415543f5ab4879f7fb5915e5d07c705650c874a248fba2e00e771315a4fc4c30411135be08c498b2a7f673d1244c00965c042437478ee4d7299b
+  data.tar.gz: 60da9f8b18cff20b6eecfebe56ca39cd7d90607907f188d50d31b13382ca8912dc0d2d06983ded2565852fb226b005ceafc6386b590dd7829faa13e88cd8e8b2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Lucas
+
+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,31 @@
+# ShowcaseFilter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'showcase_filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install showcase_filter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/showcase_filter/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,19 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :console do
+  load_irb
+end
+
+def load_irb
+  require 'irb'
+  require 'rspec'
+  require_relative 'spec/spec_helper'
+  ARGV.clear
+  IRB.start
+end
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/showcase_filter/constants/exclude_entity.rb

@@ -0,0 +1,5 @@
+module ShowcaseFilter
+  module Constants
+    ExcludeEntity = Struct.new(:exclude)
+  end
+end

data/lib/showcase_filter/core.rb

@@ -0,0 +1,52 @@
+module ShowcaseFilter
+  class Core
+    def self.filter(collection)
+      collection.inject(ShowcaseFilter::Models::GroupCollection.new([])) {|arr, entity|
+        attribute = yield(entity, Constants::ExcludeEntity.new(true))
+        a = arr.select {|group| group.label == attribute}
+        if attribute.class != Constants::ExcludeEntity
+          if a.empty?
+            group = Models::Group.new(label: attribute)
+          else
+            group = a.first
+          end
+          group.entities << entity
+          arr << group
+        end
+        arr
+      }.uniq
+    end
+
+    def self.match(expression, group_array)
+      groups = ShowcaseFilter::Models::GroupCollection.new(group_array).flatten
+      match_expression = self.evaluate_expression(expression)
+
+      if match_expression.nil?
+        return ShowcaseFilter::Models::GroupCollection.new([])
+      end
+
+      group1 = groups.find_by_label(match_expression.group1)
+      group2 = groups.find_by_label(match_expression.group2)
+
+      if group1.nil? or group2.nil?
+        return ShowcaseFilter::Models::GroupCollection.new([])
+      else
+        return group1.entities.send(match_expression.operator.to_sym, group2.entities)
+      end
+    end
+
+    def self.evaluate_expression(expression)
+      # Supported operators are : union(+), exclusion(-) and intersection(&)
+      regex = /(\w+)\s*(\+|\-|\&)\s*(\w+)/
+      match_result = expression.match(regex)
+      return nil if match_result.nil?
+
+      ShowcaseFilter::Models::Expression.new({
+          :expression => match_result[0],
+          :operator => match_result[2],
+          :group1 => match_result[1],
+          :group2 => match_result[3]
+      })
+    end
+  end
+end

data/lib/showcase_filter/models/entity_collection.rb

@@ -0,0 +1,9 @@
+module ShowcaseFilter
+  module Models
+    class EntityCollection < Array
+      def rows(value)
+        self.each_slice(value).to_a
+      end
+    end
+  end
+end

data/lib/showcase_filter/models/expression.rb

@@ -0,0 +1,12 @@
+module ShowcaseFilter
+  module Models
+    class Expression
+      include ::Virtus.model
+
+      attribute :expression, String
+      attribute :operator, String
+      attribute :group1, String
+      attribute :group2, String
+    end
+  end
+end

data/lib/showcase_filter/models/group.rb

@@ -0,0 +1,10 @@
+module ShowcaseFilter
+  module Models
+    class Group
+      include ::Virtus.model
+
+      attribute :label, String
+      attribute :entities, Array
+    end
+  end
+end

data/lib/showcase_filter/models/group_collection.rb

@@ -0,0 +1,13 @@
+module ShowcaseFilter
+  module Models    
+    class GroupCollection < Array
+      def +(other_array)
+        self.concat(other_array)
+      end
+
+      def find_by_label(label)
+        self.select { |group| group.label == label }.first
+      end
+    end
+  end
+end

data/lib/showcase_filter/version.rb

@@ -0,0 +1,3 @@
+module ShowcaseFilter
+  VERSION = "0.0.1"
+end

data/lib/showcase_filter.rb

@@ -0,0 +1,11 @@
+require "showcase_filter/version"
+require "showcase_filter/core"
+require "showcase_filter/constants/exclude_entity"
+require "showcase_filter/models/entity_collection"
+require "showcase_filter/models/group_collection"
+require "showcase_filter/models/group"
+require "showcase_filter/models/expression"
+
+
+module ShowcaseFilter
+end

data/showcase_filter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'showcase_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "showcase_filter"
+  spec.version       = ShowcaseFilter::VERSION
+  spec.authors       = ["Lucas Santana", "Renato Alves"]
+  spec.email         = ["lucas.santanadesouza@gmail.com", "renatodex@gmail.com"]
+  spec.summary       = %q{Group, intersect and Match collections using custom rules }
+  spec.description   = %q{Group, intersect and Match collections using custom rules.}
+  spec.homepage      = "https://github.com/lojabasico/showcase_filter"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "virtus", "~> 1.0"
+  spec.add_development_dependency "pry", "~> 0.0"
+end

data/spec/lib/showcase_filter_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+def variants
+  [
+    Variant.new("gola c", "branca", "p", 1),
+    Variant.new("gola v", "preta", "m", 3),
+    Variant.new("gola c", "branca", "m", 0),
+    Variant.new("gola c", "azul", "GG", 1)
+  ]
+end
+
+Variant = Struct.new(:name, :color, :size, :count_on_hand)
+
+describe ShowcaseFilter do
+  context "entities collection" do
+    it "should know how to break entities in row" do
+      entities_collection = ShowcaseFilter::Models::EntityCollection.new([1,2,3,4,5,6,7,8])
+      rows = entities_collection.rows(4)
+      expect(rows.first.join(',')).to eq '1,2,3,4'
+      expect(rows.last.join(',')).to eq '5,6,7,8'
+    end
+  end
+
+  context "group collection" do
+      it {
+        s = ShowcaseFilter::Core.filter(variants) do |entity, exclude|
+          entity.color
+        end
+
+        expect(s.find_by_label("azul").label).to eq "azul"
+      }
+
+      it "concat group collections should generate a new GroupCollection" do
+        g1 = ShowcaseFilter::Models::GroupCollection.new([1])
+        g2 = ShowcaseFilter::Models::GroupCollection.new([2])
+        expect((g1+g2).count).to eq 2
+        expect(g1+g2).to be_a ShowcaseFilter::Models::GroupCollection
+      end
+  end
+
+  context "evaluate expression" do
+    [
+      { :type => "union", :expression => "dog+cat", :match1 => "dog", :match2 => "+", :match3 => "cat" },
+      { :type => "intersection", :expression => "dog&cat", :match1 => "dog", :match2 => "&", :match3 => "cat" },
+      { :type => "exclusion", :expression => "dog-cat", :match1 => "dog", :match2 => "-", :match3 => "cat" },
+      { :type => "spaces", :expression => "dog   +   cat", :match1 => "dog", :match2 => "+", :match3 => "cat" }
+    ].each do |info|
+      it "should evaluate #{info[:type]} expression" do
+        match = ShowcaseFilter::Core.evaluate_expression(info[:expression])
+        expect(match).to be_a ShowcaseFilter::Models::Expression
+        expect(match.group1).to eq info[:match1]
+        expect(match.operator).to eq info[:match2]
+        expect(match.group2).to eq info[:match3]
+      end
+    end
+
+    it "should return false for invalid expressions" do
+      match = ShowcaseFilter::Core.evaluate_expression("dog ** cat")
+      expect(match).to be nil
+    end
+  end
+
+  context "group intersection" do
+    before(:each) do
+      @g1 = ShowcaseFilter::Core.filter(variants) do |entity|
+        entity.color
+      end
+      @g2 = ShowcaseFilter::Core.filter(variants) do |entity|
+        entity.size
+      end
+    end
+
+    it {
+      g3 = ShowcaseFilter::Core.match("branca & p", [@g1,@g2])
+      expect(g3.count).to eq 1
+    }
+
+    it "should return empty array if any group is empty" do
+      g3 = ShowcaseFilter::Core.match("branca & pp", [@g1,@g2])
+      expect(g3.count).to eq 0
+    end
+
+    it "should return empty array if operator is invalid" do
+      g3 = ShowcaseFilter::Core.match("branca x pp", [@g1,@g2])
+      expect(g3.count).to eq 0
+    end
+
+    it "should return empty array if arrays are invalid" do
+      g3 = ShowcaseFilter::Core.match("branca x pp", [nil,nil])
+      expect(g3.count).to eq 0
+    end
+
+    it "should match class" do
+      g3 = ShowcaseFilter::Core.match("branca & p", [@g1,@g2])
+      expect(g3.count).to eq 1
+    end
+  end
+
+  context "auto group discover" do
+    it "normal case" do
+      expect(variants.count).to eq 4
+
+      s = ShowcaseFilter::Core.filter(variants) do |entity|
+        entity.color
+      end
+
+      expect(s.count).to eq 3
+      expect(s.first.label).to eq "branca"
+      expect(s.first.entities.count).to eq 2
+      expect(s[1].label).to eq "preta"
+      expect(s[1].entities.count).to eq 1
+      expect(s[2].label).to eq "azul"
+      expect(s[2].entities.count).to eq 1
+    end
+
+    it "excluding case" do
+      s = ShowcaseFilter::Core.filter(variants) do |entity, exclude|
+        if entity.count_on_hand > 0
+          entity.color
+        else
+          exclude
+        end
+      end
+
+      expect(s.count).to eq 3
+      expect(s.first.label).to eq "branca"
+      expect(s.first.entities.count).to eq 1
+      expect(s[1].label).to eq "preta"
+      expect(s[1].entities.count).to eq 1
+      expect(s[2].label).to eq "azul"
+      expect(s[2].entities.count).to eq 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+require 'bundler'
+Bundler.setup
+require 'virtus'
+require 'pry'
+
+require "showcase_filter"
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: showcase_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lucas Santana
+- Renato Alves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: virtus
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: Group, intersect and Match collections using custom rules.
+email:
+- lucas.santanadesouza@gmail.com
+- renatodex@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/showcase_filter.rb
+- lib/showcase_filter/constants/exclude_entity.rb
+- lib/showcase_filter/core.rb
+- lib/showcase_filter/models/entity_collection.rb
+- lib/showcase_filter/models/expression.rb
+- lib/showcase_filter/models/group.rb
+- lib/showcase_filter/models/group_collection.rb
+- lib/showcase_filter/version.rb
+- showcase_filter.gemspec
+- spec/lib/showcase_filter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lojabasico/showcase_filter
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Group, intersect and Match collections using custom rules
+test_files:
+- spec/lib/showcase_filter_spec.rb
+- spec/spec_helper.rb