civil 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bbae03b7c5bb563b1b6e728fefd604be43ba5fe
-  data.tar.gz: 6d2fe1f7674b416b0d4341dcd06c9e2b1ee96215
+  metadata.gz: 8390c4a979faf2430eade2b066f488d1f4513a20
+  data.tar.gz: ac8dbd887ea9a374235673365b8684a6b9ad087e
 SHA512:
-  metadata.gz: 53b669f68cbc9a2fb46d55b30f35e188ffbc9837efa5ce15491bdd527f8b9aa2e06193bf21e8b802fee68e6ea3a10f4b2eb1100d1d04dde60e4a6153d3c0c6dc
-  data.tar.gz: 79ab0143ea4e81584384503ad57024dfd3707b3acc96f720ff682042960928cb69f04021af8946ef50a664d9aef9c190719f711e269bf40ce5d7af1b90ed686f
+  metadata.gz: 9346f18a5657d97e9c5f954548e75875dc7ee1bab62462024aaca32d03c0bd93624d8b7156415f0f26382e5b6a413b0956607866df81ba0531a82cc5170e8bc7
+  data.tar.gz: 3545447288f314cad524427a52d1ab3c0e93bb7aa179c9e68d6968a681c9f3d6c476650db7c2faed530971f056b8e470cadb827d87ec05b838ba2580e2a1b4df

data/CHANGELOG.md

@@ -6,6 +6,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+## [2.0.0] - 2016-12-13
+### Added
+- `Civil::Hash` and `Civil::Set` utility classes created to enable filtering.
+- `Civil::Set#where` allows filtering result conditions and meta based on
+  hashes (e.g., `result.conditions[:foo].where(id: 3)`).
+### Changed
+- Result conditions and meta are now instances of `Civil::Hash`, whose values
+  can contain instances of `Civil::Set`. This change allows you to filter results
+  and will allow for other neat tricks in the future.
+- Any time a hash is passed to `add_condition` or `add_meta`, it is
+  automatically converted to and stored as a `Civil::Hash` instance to enable
+  filtering to work.
+
 ## [1.1.0] - 2016-12-2
 ### Added
 - You can now run services by passing in blocks to `call`. The service will
@@ -38,5 +51,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - Documentation and examples in README.md
 - This changelog :-)
 
-[Unreleased]: https://github.com/earksiinni/civil/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/earksiinni/civil/compare/v2.0.0...HEAD
+[1.2.0]: https://github.com/earksiinni/civil/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/earksiinni/civil/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/earksiinni/civil/compare/v0.1.0...v1.0.0

data/README.md

@@ -106,7 +106,7 @@ end
 
 result = MetadataExample.call doodad: doodad
 
-result.meta # { length: 12.5 }
+result.meta # { length: {12.5} }
 ```
 
 ### Overriding the service block
@@ -129,6 +129,33 @@ end
 result = MyService.call { step_one; result; }
 ```
 
+### Filtering
+
+Filter metadata and results by using `where`:
+
+```ruby
+class BuildCars
+  ...
+
+  def trigger_some_conditions_and_metadata
+    if make == 'Wondercar'
+      add_condition :cars, { make: 'Wondercar', msg: 'no such make' }
+      add_condition :cars, { make: 'Wondercar', msg: 'not a thing' }
+      add_meta :cars, { make: 'Wondercar', msg: 'pretty cool name, though' }
+    end
+  end
+end
+
+result = BuildCars.call(makes: ['Wondercar', 'Lamecar', 'Hamilcar'])
+
+result.conditions[:cars].where(make: 'Wondercar') # {{ make: 'Wondercar', msg: 'no such make'}, { make: 'Wondercar', msg: 'not a thing'}}
+result.conditions[:cars].where(make: 'Wondercar', msg: 'not a thing') # {{ make: 'Wondercar', msg: 'not a thing'}}
+result.meta[:cars].where(make: 'Wondercar') # {{ make: 'Wondercar', msg: 'pretty cool name, though' }}
+```
+
+For filtering to work properly, you must pass a hash or an instance of
+`Civil::Hash` to `add_condition`/`add_meta`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -143,4 +170,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/earksi
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/civil.rb

@@ -1,3 +1,5 @@
 require "civil/version"
 require "civil/service"
 require "civil/result"
+require "civil/hash"
+require "civil/set"

data/lib/civil/hash.rb

@@ -0,0 +1,11 @@
+module Civil
+  class Hash < ::Hash
+    def =~(attrs)
+      attrs.each do |k, v|
+        keys.include?(k) && self[k] == v or return false
+      end
+
+      return true
+    end
+  end
+end

data/lib/civil/result.rb

@@ -2,7 +2,7 @@ module Civil
   class Result
     attr_reader :data, :conditions, :meta
 
-    def initialize(data, conditions = {}, meta = {})
+    def initialize(data, conditions = Civil::Hash.new, meta = Civil::Hash.new)
       @data = data
       @conditions = conditions
       @meta = meta

data/lib/civil/service.rb

@@ -18,7 +18,7 @@ module Civil
         # Initiate service execution and return standardized result
         #
         # result = MyService.call(foo: 1, bar: 'a')
-        # 
+        #
         # if result.ideal?
         #   ...
         # else
@@ -40,25 +40,23 @@ module Civil
     end
 
     def add_condition(key, condition)
-      conditions = (_conditions[key.to_sym] ||= [])
+      conditions = (_conditions[key.to_sym] ||= Civil::Set.new)
 
       conditions << condition
-      conditions.compact!
     end
 
     def add_meta(key, metadatum)
-      meta = (_meta[key.to_sym] ||= [])
+      meta = (_meta[key.to_sym] ||= Civil::Set.new)
 
       meta << metadatum
-      meta.compact!
     end
 
     def _conditions
-      @_conditions ||= {}
+      @_conditions ||= Civil::Hash.new
     end
 
     def _meta
-      @_meta ||= {}
+      @_meta ||= Civil::Hash.new
     end
   end
 end

data/lib/civil/set.rb

@@ -0,0 +1,27 @@
+module Civil
+  class Set < ::Set
+    def initialize(enum = nil)
+      enum = enum.map { |e| e.is_a?(::Hash) ? Civil::Hash.new.merge(e) : e } if enum
+
+      super
+    end
+
+    def add(o)
+      o and o.is_a?(::Hash) and o = Civil::Hash.new.merge(o)
+
+      super
+    end
+
+    def <<(o)
+      add(o)
+    end
+
+    def where(attrs)
+      self.inject(Civil::Set.new) { |set, item|
+        item.is_a?(Civil::Hash) and item =~ attrs and set.add(item)
+
+        set
+      }
+    end
+  end
+end

data/lib/civil/version.rb

@@ -1,3 +1,3 @@
 module Civil
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: civil
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ersin Akinci
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-03 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,8 +90,10 @@ files:
 - bin/setup
 - civil.gemspec
 - lib/civil.rb
+- lib/civil/hash.rb
 - lib/civil/result.rb
 - lib/civil/service.rb
+- lib/civil/set.rb
 - lib/civil/version.rb
 homepage: https://github.com/earksiinni/civil
 licenses: