data_filter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: affd888942cfb7bbac784fd91eef29c15b1d157b
-  data.tar.gz: b76273d0e917aec6d45e141175014547235c19f2
+  metadata.gz: 332f6db7efb59c1ca7fef5a07295d33f682531bb
+  data.tar.gz: dfe88c3afd902a7698b1911e2bad58fc0343b27a
 SHA512:
-  metadata.gz: b1155098d7771a6fdcd50938918e77bb60fc40cb36401e4db4e2fc7a485d260fa248152440d75e4c19b442fa3e7904f66be7a5ea2793fc8134f5791abd0328fc
-  data.tar.gz: f06a4205f198f30b1ede769a4868ae162a5c89891b608712efb3d11a4ff6495ad6f333c52b9f5d669a27f44446db537065f40216ebaa00c091b355609d233f02
+  metadata.gz: 06b680bdcd3e803987fc9466d0bcc10a1467f36c0aa69a64b18705c9666cf9eac4b9e8b2b37aca738fd12f3ab922b5429a36b227b207925577ce66797c9094a9
+  data.tar.gz: 3ba38ef1ddf6b50f43fabb22bca09f7bc27c4bef470f48c8ff6958d97e3d0923fd4997ddc74bcef271af9a9ed0ca39fc07d4f9a70084462dc0c3f2431c307c65

data/README.md

@@ -7,9 +7,13 @@
 
 an extensible DSL for filtering data sets
 
+## Summary
+
+`DataFilter` is a library for creating filters that are consistent, reusable, and easy to read. A filter is simply something that decides whether or not an element should be removed from a set. For example, we could create a `DataFilter::FilterSet` that is comprised of various filters and then pass an array into the filter set. The filter set will then remove elements that do not pass each of the filters.
+
 ## Installation
 
-```rb
+```
 gem install data_filter
 ```
 
@@ -35,13 +39,16 @@ filter_set = DataFilter::FilterSet.create do
   # Check if within range
   range_filter :age, ceiling: params[:max_age]
 
+  # Check if ranges overlap
+  range_filter :start, :end, floor: Date.parse('2015-01-01')
+
   # Add a custom filter
   add_filter -> (user) { user if user.student || user.age > 25 }
 end
 
 data = [
-  User.create(name: 'Josh', age: 26, student: false, gender: :male),
-  User.create(name: 'Lauren', age: 25, student: true, gender: :female)
+  User.create(name: 'Josh', age: 26, student: false, gender: :male, start: Date.parse('2007-01-01'), end: Date.parse('2013-01-01')),
+  User.create(name: 'Lauren', age: 25, student: true, gender: :female, start: Date.parse('2008-01-01'), end: Date.parse('2016-01-01'))
 ]
 
 # By default data which doesn't match all of the filters will be filtered out
@@ -51,6 +58,10 @@ filter_set.call(data)
 ## Changelog
 
 ```
+* v0.3.0
+
+- Added PrefixFilter
+
 * v0.2.0
 
 - Fix RangeOverlapFilter edge cases

data/lib/data_filter/like_filter.rb

@@ -36,12 +36,12 @@ module DataFilter
       when Hash
         match?(actual.values.flatten, search_term)
       when Array
-        actual.any? {|item| match?(item, search_term)}
+        actual.any? { |item| match?(item, search_term) }
       when String
         regexp =
           normalize(search_term, true)
             .split(' ')
-            .map {|term| Regexp.escape(term)}
+            .map { |term| Regexp.escape(term) }
             .join('|')
             .insert(0, '(')
             .insert(-1, ')')

data/lib/data_filter/prefix_filter.rb

@@ -0,0 +1,37 @@
+module DataFilter
+  # Used to filter a data item by a prefix by seeing if
+  # the data field value starts with the prefix
+  #
+  # @example
+  #   object = MyModel.new(text: 'hello world!')
+  #   filter = DataFilter::PrefixFilter.new(:text, 'hello')
+  #   filter.call(object)
+  #   # => #<MyModel text: 'hello world'>
+  class PrefixFilter
+    # @param field_sym [Symbol] name of the data method we want
+    #   to filter
+    # @param prefix [String] the value we want to use when
+    #   filtering the data item
+    def initialize(field_sym, prefix)
+      @field_sym = field_sym
+      @prefix = prefix
+    end
+
+    # Filters the item
+    #
+    # @param item [Object] the item we want to filter
+    # @return [Object, nil] the original data item
+    def call(item)
+      if item.respond_to?(@field_sym) &&
+        starts_with?(item.public_send(@field_sym), @prefix)
+        item
+      end
+    end
+
+    private
+
+    def starts_with?(actual, prefix)
+      actual.match(/\A#{prefix}/i)
+    end
+  end
+end

data/lib/data_filter/version.rb

@@ -1,3 +1,3 @@
 module DataFilter
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/data_filter.rb

@@ -7,5 +7,6 @@ require 'data_filter/range_filter'
 require 'data_filter/like_filter'
 require 'data_filter/range_overlap_filter'
 require 'data_filter/truthy_filter'
+require 'data_filter/prefix_filter'
 
 module DataFilter; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_filter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Bodah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,13 +80,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - data_filter.gemspec
 - lib/data_filter.rb
 - lib/data_filter/filter_set.rb
 - lib/data_filter/keyword_filter.rb
 - lib/data_filter/like_filter.rb
+- lib/data_filter/prefix_filter.rb
 - lib/data_filter/range_filter.rb
 - lib/data_filter/range_overlap_filter.rb
 - lib/data_filter/truthy_filter.rb
@@ -111,8 +110,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: an extensible DSL for filtering data sets
 test_files: []
+has_rdoc: 

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "data_filter"
-
-# 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
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here