massager 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0de927f4b6c1c57de9734a7f173c9c2429f29fee
-  data.tar.gz: b76f29ffbd8e782c8a00a28f38c5001be83f6ef1
+  metadata.gz: 53f2c10f9317523283972f8951006e762166f9c9
+  data.tar.gz: ce31aa5c501efde93d6b7fa5ad2787690e502689
 SHA512:
-  metadata.gz: 3a444f625b9641cc69b4c944c9170164ea28e1e8aec0967237db696bd9cbfa278cf1ec7fcf0fe345346cf6d3db3fec5a49d36ba28fcb2ac28c9c7138b97b1ed2
-  data.tar.gz: a56754ed98e5b0861beccd7ef7e45c38727c5697cdb7466a5fcf1a6f0d46b25139e499d391d956bf717607aa88b5724129f557cd73ecdaf178e525f5974acd69
+  metadata.gz: 738f93609dbd29d766e922f239d2da48aab11404b449e7a0041263f8f3af7dd493c83acb3120e7a208c134ad9627d3244d9f793dbf89316cc44b6ea7cad9aa6d
+  data.tar.gz: b5e655c41a1a8623a006c4f09190508a22e648c2ce79f7b29f26a2af6fa21206562d26db128042faa8ea5f1e785492a42eb33dedfc7da0ddfcf90d42e6d28ba1

data/README.md

@@ -1,8 +1,6 @@
 # Massager
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/massager`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Have you ever felt a need to massage your data just a little bit before working with it? This is what Massager was built for.
 
 ## Installation
 
@@ -20,20 +18,114 @@ Or install it yourself as:
 
     $ gem install massager
 
-## Usage
+## Simplest usecase
+To start using Massager, just include it in your classes, like so:
+```ruby
+class ExampleClass
+  include Massager
+  attribute :foo, "bar"
+end
+```
+In this scenario, the "bar" key's value will become the result `foo` method
+```ruby
+testable = ExampleClass.build({"bar" => "value"})
+testable.foo #=> "value"
+```
+
+## Type checking
+You can also pass type checks using dry-types library:
+```ruby
+class ExampleClass
+  include Massager
+  attribute :foo, "bar", type: Types::Strict::String
+end
+```
+It will raise an error if the type is not correct:
+```ruby
+testable = ExampleClass.build({"bar" => "value"})
+testable.foo #=> "value"
+testable = ExampleClass.build({"bar" => 123})
+testable.foo #=> raises Dry::Types::ConstraintError
+```
+If you want to define your own types, check the Dry Types library. Type needs to respond to `call` method, so 
+you can define your own
+
+## Preprocessing the value via block
+
+You can add bit of preprocessing via block (The type check will be preformed afer the block is executed):
+```ruby
+class ExampleClass
+  include Massager
+  attribute :foo, "bar", type: Types::Strict::String do |v|
+    v.upcase
+  end
+end
+```
+And it will have following result
+```ruby
+testable = ExampleClass.build({"bar" => "value"})
+testable.foo #=> "VALUE"
+```
 
-TODO: Write usage instructions here
+## Combining multiple keys
 
-## Development
+```ruby
+class ExampleClass
+  include Massager
+  attribute :foo, "bar", "baz", type: Types::Strict::String do |bar, baz|
+    "#{bar} #{baz}"
+  end
+end
+```
+Note that if you pass multiple keys, the modifier block is mandatory
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+testable = ExampleClass.build({"bar" => "bar", "baz" => "baz"})
+testable.foo #=> "bar baz"
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Enum attributes
+If you want to have enum as a result, you will need to use `enum_attribute`
+```ruby
+class ExampleClass
+  include Massager
+  enum_attribute :foo, "bar", "baz"
+end
+```
+```ruby
+testable = ExampleClass.build({"bar" => "bar", "baz" => "baz"})
+testable.foo #=> ["bar", "baz"]
+```
 
-## Contributing
+## Enum attribute with modifier
+You can apply modifications to the collection
+```ruby
+class ExampleClass
+  include Massager
+  enum_attribute :foo, "bar", "baz" do |values| 
+    values.reverse
+  end
+end
+```
+```ruby
+testable = ExampleClass.build({"bar" => "bar", "baz" => "baz"})
+testable.foo #=> ["baz", "bar"]
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/massager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+## Enum attribute with type check
+You can provide type checks as well
+```ruby
+class ExampleClass
+  include Massager
+  enum_attribute :foo, "bar", "baz", type: Types::Strict::Array.member(Types::Strict::String)
+end
+```
+```ruby
+testable = ExampleClass.build({"bar" => "bar", "baz" => "baz"})
+testable.foo #=> ["bar", "baz"]
 
+testable = ExampleClass.build({"bar" => 123, "baz" => "baz"}) # Will raise Dry::Types::ConstraintError
+```
 
 ## License
 

data/lib/massager/attributes/attribute.rb

@@ -0,0 +1,29 @@
+module Massager
+  class Attribute
+    def initialize(name:, target_keys:, opts: {}, block: nil)
+      raise ArgumentError, "If you pass multiple keys, you have to use modifier block" if block.nil? && target_keys.count > 1
+      @name, @target_keys, @opts, @block = name, target_keys, opts, block
+    end
+
+    def call(values)
+      begin
+        values = values.values_at(*target_keys)
+        Dry::Monads::Maybe(block).fmap {|block| values = block.call(*values)}
+        Dry::Monads::Maybe(opts[:type]).fmap {|type| values = type.call(*values)}
+        return_result(*values)
+      rescue ArgumentError
+        raise ArgumentError, "The result of modifier block should return single element"
+      end
+    end
+
+    def return_result(values)
+      values
+    end
+
+    def match_schema?(attrs)
+      (attrs.keys & target_keys).any?
+    end
+
+    attr_reader :target_keys, :block, :opts, :name
+  end
+end

data/lib/massager/attributes/enum_attribute.rb

@@ -0,0 +1,21 @@
+module Massager
+  class EnumAttribute
+    def initialize(name:, target_keys:, opts: {}, block:)
+      @name, @target_keys, @opts, @block = name, target_keys, opts, block
+    end
+
+    def call(values)
+      values = values.values_at(*target_keys)
+      Dry::Monads::Maybe(block).fmap {|block| values = block.call(values)}
+      Dry::Monads::Maybe(opts[:type]).fmap {|type| values = type.call(values)}
+      raise ArgumentError, "The result of modifier block is not an enum" unless values.respond_to? :each
+      values
+    end
+
+    def match_schema?(attrs)
+      (attrs.keys & target_keys).any?
+    end
+
+    attr_reader :target_keys, :block, :opts, :name
+  end
+end

data/lib/massager/version.rb

@@ -1,3 +1,3 @@
 module Massager
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/massager.rb

@@ -3,52 +3,60 @@ require "dry-types"
 require "dry-monads"
 require "dry-container"
 
+require "massager/attributes/attribute"
+require "massager/attributes/enum_attribute"
 
 module Massager
   module ClassMethods
-    def column(name, target_key, type: nil, &block)
+    def attribute(name, *target_keys, **opts, &block)
       set_container
-      register_column_info(target_key, name, type, block)
-      define_setter(target_key)
-      define_getter(target_key)
+      register_attribute(
+        Attribute.new(name: name, target_keys: target_keys, opts: opts, block: block)
+      )
+      define_setter(name)
+      define_getter(name)
+    end
+
+    def enum_attribute(name, *target_keys, **opts, &block)
+      set_container
+      register_attribute(
+        EnumAttribute.new(name: name, target_keys: target_keys, opts: opts, block: block)
+      )
+      define_setter(name)
+      define_getter(name)
     end
 
     def build(attrs)
-      instance = self.new
-      attrs.each do |k,val|
-        container = self.container.resolve(k)
-        instance.send("#{container[:name]}=", val)
+      instance = new
+      container.each_key do |k|
+        attribute = container.resolve(k)
+        instance.public_send("#{k}=", attrs) if attribute.match_schema?(attrs)
       end
       instance
     end
 
     private
 
-    def set_container
-      self.define_singleton_method(:container) do
-        @container ||= Dry::Container.new
-      end
+    def register_attribute(attribute)
+      container.register(attribute.name) {attribute}
     end
 
-    def define_setter(target_key)
-      container = self.container.resolve(target_key)
-      define_method "#{container[:name]}=", Proc.new {|val|
-        container[:block].fmap {|v| val = v.call(val)}
-        container[:type].fmap {|v| val = v[val]}
-        instance_variable_set(:"@#{container[:name]}", val)
+    def define_setter(name)
+      define_method "#{name}=", Proc.new {|values|
+        attribute = self.class.container.resolve(name)
+        instance_variable_set(:"@#{name}", attribute.call(values))
       }
     end
 
-    def define_getter(target_key)
-      container = self.container.resolve(target_key)
-      define_method container[:name], Proc.new {
-        instance_variable_get(:"@#{container[:name]}")
+    def define_getter(name)
+      define_method name, Proc.new {
+        instance_variable_get(:"@#{name}")
       }
     end
 
-    def register_column_info(target_key, name, type, block)
-      container.register(target_key) do
-        {name: name, target_key: target_key, type: Dry::Monads::Maybe(type), block: Dry::Monads::Maybe(block)}
+    def set_container
+      self.define_singleton_method(:container) do
+        @container ||= Dry::Container.new
       end
     end
   end
@@ -57,4 +65,3 @@ module Massager
     base.extend(ClassMethods)
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: massager
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Janis Miezitis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -99,6 +99,8 @@ files:
 - bin/console
 - bin/setup
 - lib/massager.rb
+- lib/massager/attributes/attribute.rb
+- lib/massager/attributes/enum_attribute.rb
 - lib/massager/version.rb
 - massager.gemspec
 homepage: http://github.com/janjiss/massager