fanli 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a443bfa0dd9e8f717bf346d5d27579c26c217454
-  data.tar.gz: e89db1278142a0005795374d4c0f68dbe12cb9a2
+  metadata.gz: c21e9111e908bd2f7678fccfce79032590b94757
+  data.tar.gz: 758209c675394a3154dc12ef00340116f2465904
 SHA512:
-  metadata.gz: 79f34296eafc6cccd14438dcb09c00f28249cafb06775323ce785865334e44474ec0f2195bfdb4bc00134dc18982410c748e85787a087b22758ee6ecb9c85136
-  data.tar.gz: d415c741ac7d660435bd0c3bb550a497e3f9c02ec334398313d51ac0c9f1ab7935279876be495e6bc4ac2be3a9235c2bfef8f56a0b934a5916f8e1d20d39308b
+  metadata.gz: 8a57f073dc1505d9fa828e207ab54fae8deb4d190ef45201d9d36da1f5fc967e79abb4ea7ae6e8b3675be241372422c3b7bd2511c5a1eb88bd78748a574e7c1a
+  data.tar.gz: 03a0a82fcade8bec83dc58df943bc4c92536515b938de3de892d6e7b6d52041816fb53a22b8d747bf614954b6bf95f13d78b6a794f836d8387a260dc6ded32f2

data/Gemfile

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

data/README.md

@@ -30,7 +30,7 @@ Or install it yourself as:
 > 3. Give $5 cash if he's from Beijing
 > 4. And many more business rules in the future...
 
-Following "The Rails Way", you may implement these rules **ALL** in the `User` model like this:
+In your rails code, you may implement these rules **ALL** in the `User` model like this:
 
 ```ruby
 class User < ActiveRecord::Base
@@ -57,6 +57,7 @@ class User < ActiveRecord::Base
   end
 end
 ```
+
 This will result in "Fat Models" that violate the SRP("[Single responsibility principle](https://en.wikipedia.org/wiki/Single_responsibility_principle)").
 
 To solve this problem and prevent messy code, you should write code in "The Fanli Way":
@@ -73,7 +74,7 @@ To solve this problem and prevent messy code, you should write code in "The Fanl
     ```ruby
     # app/business/create_user.rb
     class CreateUser < Fanli::Base
-      def perform(args)
+      def call(args)
         User.create!(args)
       end
     end
@@ -99,7 +100,7 @@ To solve this problem and prevent messy code, you should write code in "The Fanl
     end
     ```
 
-    ```
+    ```ruby
     # app/business/give_initial_cash.rb
     class GiveInitialCash
       def self.on_create_user(args)
@@ -111,14 +112,26 @@ To solve this problem and prevent messy code, you should write code in "The Fanl
 4. Register each business logic class:
 
     ```ruby
-    # config/initializers/business.rb
-    Fanli.on(:create_user, [
+    # app/business/registry.rb
+    Fanli.when(:create_user, exec: [
       SendWelcomeEmail,
       GiveCouponIfXmas,
       GiveInitialCash
     ])
     ```
-5. Done! Enjoy!
+
+5. Use your business processing class in your controller:
+
+    ```ruby
+    # app/controllers/users_controller.rb
+    class UsersController < ApplicationController
+      def create
+        CreateUser.with(params.require(:user).permit(:name, :email))
+      end
+    end
+    ```
+
+6. Done! Enjoy!
 
 ## Development
 

data/fanli.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["David Zhang"]
   spec.email         = ["daqing1986@gmail.com"]
 
-  spec.summary       = %q{Fanli helps you doing business (logic)}
+  spec.summary       = %q{Fanli helps you doing **complex** business (logic)}
   spec.homepage      = "http://github.com/daqing/fanli"
   spec.license       = "MIT"
 

data/lib/fanli/base.rb

@@ -4,15 +4,15 @@ module Fanli
       sub.extend(ClassMethods)
     end
 
-    def perform(*_args)
-      throw(:please_create_your_own_perform_method)
+    def call(*_args)
+      throw(:please_create_your_own_call_method)
     end
 
     module ClassMethods
-      def do(opts)
+      def with(opts)
         obj = new
-        obj.perform(opts)
-        Fanli.notify(snikize(name), opts)
+        obj.call(opts)
+        Fanli.trigger(snikize(name), with: opts)
       end
 
       private

data/lib/fanli/version.rb

@@ -1,3 +1,3 @@
 module Fanli
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/fanli.rb

@@ -5,18 +5,18 @@ require 'fanli/base'
 module Fanli
   @registry = {}
 
-  def self.on(ev, listener_or_collection)
-    if listener_or_collection.respond_to?(:each)
-      listener_or_collection.map do |listener|
+  def self.when(ev, exec:)
+    if exec.respond_to?(:each)
+      exec.each do |listener|
         add_listener(@registry, ev.to_sym, listener)
       end
     else
-      add_listener(@registry, ev.to_sym, listener_or_collection)
+      add_listener(@registry, ev.to_sym, exec)
     end
   end
 
-  def self.notify(ev, args)
-    apply_callback("on_#{ev}", args, @registry[ev.to_sym])
+  def self.trigger(ev, with:)
+    apply_callback("on_#{ev}", with, @registry[ev.to_sym])
   end
 
   def self.reset

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fanli
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - David Zhang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,5 +112,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Fanli helps you doing business (logic)
+summary: Fanli helps you doing **complex** business (logic)
 test_files: []