attr_pouch 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e70f1aaa49e8c698db7004d2137dff0fb396462
-  data.tar.gz: e29ed8ec737976e0e65180c79c3a4736f92d691f
+  metadata.gz: 0bc7099e267a11a0723eaa8b16654b6221e928bc
+  data.tar.gz: 79fad57b11a02ac0b0093c4d579c7fc109dbbb70
 SHA512:
-  metadata.gz: 4961584f437d46255b6e0ce970b61b7bd9d820b943397e498c129e75176553bca6975ee52e2470fad4790ab5bfcfdb022ca920367e32a7f89b301a4fbf4ec00d
-  data.tar.gz: fd0c772494d398b7bfdfdd4e08cd52e93644cd30af48b6b98fa494b304d4ea1b8ce84d95b019098bb5f4578813a79d4d52c7707c0d7ccc1742b94f2048c0532a
+  metadata.gz: 4700d4f626b53b6d3dae2211d16e14288b8d51327f8059f8520356bf0de0f977b023fc9d6e1b32c8ec13f6b70093cb9fab0a80e09c05ef19b7e7772afc82f808
+  data.tar.gz: 83accbe6882fef94e44d1ab5aae58a2d66c811b792ce68b0a19f99032158a96e42d9547ed7305b147bd6d2035410948d1c75a84393dc0ced0e7d4c9178be41bd

data/.travis.yml

@@ -7,6 +7,6 @@ addons:
   postgresql: "9.4"
 env:
 rvm:
-  - 2.2.3
+  - 2.4.1
 notifications:
   email: false

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ruby '2.2.3'
+ruby '2.4.1'
 
 # Specify your gem's dependencies in attr_pouch.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attr_pouch (0.1.0)
+    attr_pouch (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -20,7 +20,7 @@ GEM
     rspec-mocks (3.1.3)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
-    sequel (4.13.0)
+    sequel (4.49.0)
 
 PLATFORMS
   ruby
@@ -29,7 +29,10 @@ DEPENDENCIES
   attr_pouch!
   pg (~> 0.18.3)
   rspec (~> 3.0)
-  sequel (~> 4.13)
+  sequel (~> 4.46)
+
+RUBY VERSION
+   ruby 2.4.1p111
 
 BUNDLED WITH
-   1.10.6
+   1.14.6

data/README.md

@@ -23,6 +23,15 @@ parts of your data model, but augment it with schema-less storage for
 the parts that are in flux or just awkward to fit into the relational
 model.
 
+### Installation
+
+Add `attr_pouch` to your `Gemfile`:
+
+```ruby
+gem 'attr_pouch'
+```
+
+Then run `bundle install`.
 
 ### Usage
 
@@ -35,6 +44,8 @@ fact stored in the pouch:
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
     field :theme
     field :autoplay_videos?
@@ -63,8 +74,10 @@ can be marked as optional by providing a default:
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
-	field :favorite_color, default: 'puce'
+    field :favorite_color, default: 'puce'
   end
 end
 
@@ -87,6 +100,8 @@ simple built-in types are `String`, `Integer`, `Float`, `Time`, and
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
     field :favorite_color, type: String
     field :lucky_number, type: Integer
@@ -99,10 +114,10 @@ You can override these built-ins or register entirely new types:
 
 ```ruby
 AttrPouch.configure do |config|
-  config.write(:obfuscated_string) do |field, value|
+  config.encode(:obfuscated_string) do |field, value|
     value.reverse
   end
-  config.read(:obfuscated_string) do |field, value|
+  config.decode(:obfuscated_string) do |field, value|
     value.reverse
   end
 end
@@ -123,6 +138,8 @@ This can be illustrated via the last built-in codec, for
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
     field :bff, type: User
   end
@@ -165,6 +182,8 @@ methods for them:
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
     field :proxy_address, deletable: true
   end
@@ -197,6 +216,8 @@ updates once an initial value has been set:
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
     field :lucky?, mutable: false
   end
@@ -214,6 +235,8 @@ previous names under the `was` option.
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
     field :tls?, was: :ssl?
     field :instabul?, was: %i[constantinople? byzantion?]
@@ -249,10 +272,12 @@ absent field value deferring to the default:
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
     field :bff, type: User, raw_field: :bff_id
     field :arch_nemesis, type: User, raw_field: :nemesis_id,
-	        default: User[name: 'donald']
+          default: User[name: 'donald']
   end
 end
 
@@ -275,6 +300,8 @@ contents. The interface is similar to querying first-class columns:
 
 ```ruby
 class User < Sequel::Model
+  include AttrPouch
+
   pouch(:preferences) do
     field :bff, type: User
     field :favorite_color

data/TODO

@@ -1,7 +1,6 @@
 # TODO thoughts:
-  - docs
-    - dataset
-    - update to note json / jsonb support
+  - chainable encode/decode filters
+  - support for inheritance (pouch with some fields in parent class, some in child)
   - support for access via [] and []= methods
   - opt: eager_default on create for fields
   - opt: run tracking

data/attr_pouch.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rspec", '~> 3.0'
   gem.add_development_dependency "pg", '~> 0.18.3'
-  gem.add_development_dependency "sequel", '~> 4.13'
+  gem.add_development_dependency "sequel", '~> 4.46'
 end

data/lib/attr_pouch/version.rb

@@ -1,3 +1,3 @@
 module AttrPouch
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/attr_pouch.rb

@@ -15,40 +15,42 @@ module AttrPouch
   def self.included(base)
     base.extend(ClassMethods)
     # we can't just independently define this in ClassMethods since
-    # `def_dataset_method` is only defined on Sequel::Model subclasses
-    base.def_dataset_method(:where_pouch) do |pouch_field, expr_hash|
-      ds = self
-      pouch = model.pouch(pouch_field)
-      if pouch.nil?
-        raise ArgumentError,
-              "No pouch defined for #{pouch_field}"
-      end
-      if pouch.json?
-        raise UnsupportedError, "Dataset queries not supported for columns of type json"
-      end
-
-      expr_hash.each do |key, value|
-        key = key.to_s
-        field = pouch.field_definition(key)
-        if field.nil?
+    # `dataset_module` is only defined on Sequel::Model subclasses
+    base.dataset_module do
+      define_method(:where_pouch) do |pouch_field, expr_hash|
+        ds = self
+        pouch = model.pouch(pouch_field)
+        if pouch.nil?
           raise ArgumentError,
-                "No field #{key} defined for pouch #{pouch_field}"
+                "No pouch defined for #{pouch_field}"
+        end
+        if pouch.json?
+          raise UnsupportedError, "Dataset queries not supported for columns of type json"
         end
 
-        if value.respond_to?(:each)
-          value.each_with_index do |v,i|
-            condition = pouch.store.contains(pouch.wrap(key => field.encode(v)))
-            ds = i == 0 ? ds.where(condition) : ds.or(condition)
+        expr_hash.each do |key, value|
+          key = key.to_s
+          field = pouch.field_definition(key)
+          if field.nil?
+            raise ArgumentError,
+                  "No field #{key} defined for pouch #{pouch_field}"
+          end
+
+          if value.respond_to?(:each)
+            value.each_with_index do |v,i|
+              condition = pouch.store.contains(pouch.wrap(key => field.encode(v)))
+              ds = i == 0 ? ds.where(condition) : ds.or(condition)
+            end
+          elsif value.nil?
+            ds = ds.where(pouch.store.has_key?(key) => false)
+                .or(pouch.store.contains(pouch.wrap(key => field.encode(value))))
+          else
+            ds = ds.where(pouch.store
+                          .contains(pouch.wrap(key => field.encode(value))))
           end
-        elsif value.nil?
-          ds = ds.where(pouch.store.has_key?(key) => false)
-               .or(pouch.store.contains(pouch.wrap(key => field.encode(value))))
-        else
-          ds = ds.where(pouch.store
-                         .contains(pouch.wrap(key => field.encode(value))))
         end
+        ds
       end
-      ds
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_pouch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Maciek Sakrejda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-26 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.13'
+        version: '4.46'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.13'
+        version: '4.46'
 description: Schema-less attribute storage
 email:
 - m.sakrejda@gmail.com
@@ -91,11 +91,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Sequel plugin for schema-less attribute storage
 test_files:
 - spec/attr_pouch_spec.rb
 - spec/spec_helper.rb
-has_rdoc: