power-types 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d8d84c3744f92654b42fb2ccd339cf2c1e89c10
-  data.tar.gz: b1583c97cb542a6284b0389822e421516bfbd3b0
+  metadata.gz: f159dd5e4a3a526a40fec330c362de8a529eb047
+  data.tar.gz: 970394597addd67d70142b5dd64a98a96a5098ce
 SHA512:
-  metadata.gz: 23e19ac6431e3231a5591b1cead007eb69c1a2e13b7e086192bae32a893b286b522bb9fa24ab16749fa2a8da66cf9ba294a95b04f7587d265df5a80afef9039f
-  data.tar.gz: 6a0a8aafd3056d2b2fe01049c3c7519d174d341d00a877487e4511f77cb5b47dd68386bec7c424028a2da56ca21a4d6bb4772ed9d81208cf044690a6b1878aaa
+  metadata.gz: 34896843282a2ac5eaf399c199825f1f221f42525521d7ce95a49ee7bc698d666c147de92128391e9c09b28076e6e7a051b3eb36b2820d050b3558ed5ef21f65
+  data.tar.gz: 00959cdba7efdabbedf520cdb031122c8a17e9814ee9ce18f327d92aced0b1956b0842284b378eb83427db7efc1dd1727b36617ac4697577cae661bb03db0508

data/README.md

@@ -0,0 +1,98 @@
+# Power-Types
+
+Rails pattern enforcing types used by the Platanus team
+
+## Introduction
+
+In Rails projects, Platanus encourages  to  use classes beyond models and controllers to hold the app's logic.
+These powerful types proposed are Services, Commands, Utils and Values.
+
+For a deeper understanding about the usage of these patterns, feel welcome to read the [related post in Platanus Blog](https://cb.platan.us/services-commands-y-otros-poderosos-patrones-en-rails) (in spanish).
+   
+The goal aimed with this gem is to go further, and not just apply this patterns over POROs (plain simple ruby classes).  The gem provides an special structure and syntax to create and run Services and Commands with ease.
+
+It also creates the directory for each type, and provides generators.
+
+## Usage
+
+### Generators
+
+For generating services we use:
+
+    $ rails generate service MagicMakingService foo bar
+
+This will create the MagicMakingService class, inheriting from a base service class:
+
+    class MagicMakingService < PowerTypes::Service.new(:foo, bar: nil)
+
+Default values for arguments are optional, and can't be defined in the generator, but manually after.  In this case a `nil` value was given for `bar`.
+This is a way to make the argument optional.  If no default value is assigned, the argument will be required, and an error raised if missing.
+
+This generator will create its corresponding rspec file.
+
+
+
+For generating commands:
+
+    $ rails generate command MakeMagic foo bar
+
+Which will generate the corresponding class, with the `perform` method.  This method must be implemented, and its called when the command is executed.
+
+    class MakeMagic < PowerTypes::Command.new(:foo, bar: nil)
+
+And in a similar way to services, the command's spec file is also created by this generator
+ 
+### Instantiate and Run
+ 
+We can create service objects like this
+ 
+    magic_service = MagicMakingService.new(foo: my_foo, bar: "a bar")
+
+And use any method the service provides
+    
+    magic_service.gandalfize(sauron)
+    magic_service.harry_potterize(voldemort)
+
+In the case of commands, we are not suposed to store or reuse the object.  You just want to run it and keep the result
+    
+    result = MakeMagic.for(foo: a_foo, bar:  "i'm bar")
+
+### Values and Utils
+
+This two types do not have generators.
+
+Values are just simple Ruby classes, but watch out to keep them in the Values directory!
+
+Utils should be defined as a module.  There you define the independent but related functions.  Use the extend self pattern to call them directly after the module name.
+```ruby
+module MagicTricks
+extend self
+    
+    def dissappear(object)
+        #blah blah
+    end
+    
+    def shrink(children)
+        #bleh bleeh
+    end
+
+    def shuffle(cards)
+        #blaah
+    end  
+```
+Example of calling a Util function:
+
+    MagicTricks.dissapear(rabbit)
+
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/power-types/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Power-Types is maintained by [platanus](http://platan.us).
+
+## License
+
+Power-Types is © 2016 Platanus, S.p.A. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/lib/power_types/version.rb

@@ -1,3 +1,3 @@
 module PowerTypes
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-types
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ignacio Baixas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -186,6 +186,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
+- README.md
 - Rakefile
 - lib/generators/power_types/init_generator.rb
 - lib/generators/rails/command_generator.rb