fanli 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a443bfa0dd9e8f717bf346d5d27579c26c217454
+  data.tar.gz: e89db1278142a0005795374d4c0f68dbe12cb9a2
+SHA512:
+  metadata.gz: 79f34296eafc6cccd14438dcb09c00f28249cafb06775323ce785865334e44474ec0f2195bfdb4bc00134dc18982410c748e85787a087b22758ee6ecb9c85136
+  data.tar.gz: d415c741ac7d660435bd0c3bb550a497e3f9c02ec334398313d51ac0c9f1ab7935279876be495e6bc4ac2be3a9235c2bfef8f56a0b934a5916f8e1d20d39308b

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+*.gem
+GPATH
+GRTAGS
+GTAGS
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at daqing1986@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 David Zhang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,137 @@
+# Fanli
+
+Fanli is a new way to implement **complex** business logic in your application(e.g. Rails).
+
+范蠡, 是实现复杂业务逻辑的一种新思路。（如果你的Rails model超过了200行代码，也许你该试试它~~）
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fanli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fanli
+
+## Usage
+
+> Assume you run an ecommerce site, and you may want to do the following things
+> after user registeration:
+>
+> 1. Send welcome email
+> 2. Give 20% off coupon if its xmas
+> 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:
+
+```ruby
+class User < ActiveRecord::Base
+  validates :name, :email, presence: true
+
+  after_create :send_welcome_email
+  after_create :give_coupon_if_xmas
+  after_create :give_initial_cash
+
+  # add more `after_commit` callbacks...
+
+  private
+
+  def send_welcome_email
+    # business logic goes here...
+  end
+
+  def give_coupon_if_xmas
+    # business logic goes here...
+  end
+
+  def give_initial_cash
+    # business logic goes here...
+  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":
+
+1. Create a new folder containing all the business code:
+
+    ```bash
+    $ cd [/path/to/your/rails_project]
+    $ mkdir app/business
+    ```
+
+2. Create a new "business processing class":
+
+    ```ruby
+    # app/business/create_user.rb
+    class CreateUser < Fanli::Base
+      def perform(args)
+        User.create!(args)
+      end
+    end
+    ```
+
+3. Implement each business login using separate "Plain Old Ruby Class":
+
+    ```ruby
+    # app/business/send_welcome_email.rb
+    class SendWelcomeEmail
+      def self.on_create_user(args)
+        # business logic goes here...
+      end
+    end
+    ```
+
+    ```ruby
+    # app/business/give_coupon_if_xmas.rb
+    class GiveCouponIfXmas
+      def self.on_create_user(args)
+        # business logic goes here...
+      end
+    end
+    ```
+
+    ```
+    # app/business/give_initial_cash.rb
+    class GiveInitialCash
+      def self.on_create_user(args)
+        # business logic goes here...
+      end
+    end
+    ```
+
+4. Register each business logic class:
+
+    ```ruby
+    # config/initializers/business.rb
+    Fanli.on(:create_user, [
+      SendWelcomeEmail,
+      GiveCouponIfXmas,
+      GiveInitialCash
+    ])
+    ```
+5. Done! Enjoy!
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/daqing/fanli. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fanli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fanli.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fanli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fanli"
+  spec.version       = Fanli::VERSION
+  spec.authors       = ["David Zhang"]
+  spec.email         = ["daqing1986@gmail.com"]
+
+  spec.summary       = %q{Fanli helps you doing business (logic)}
+  spec.homepage      = "http://github.com/daqing/fanli"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 9"
+end

data/lib/fanli/base.rb

@@ -0,0 +1,30 @@
+module Fanli
+  class Base
+    def self.inherited(sub)
+      sub.extend(ClassMethods)
+    end
+
+    def perform(*_args)
+      throw(:please_create_your_own_perform_method)
+    end
+
+    module ClassMethods
+      def do(opts)
+        obj = new
+        obj.perform(opts)
+        Fanli.notify(snikize(name), opts)
+      end
+
+      private
+
+      def snikize(str)
+        return '' if str.nil?
+        str.gsub(/::/, '/')
+           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+           .tr('-', '_')
+           .downcase
+      end
+    end
+  end
+end

data/lib/fanli/version.rb

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

data/lib/fanli.rb

@@ -0,0 +1,42 @@
+require 'fanli/version'
+require 'fanli/base'
+
+# Fanli
+module Fanli
+  @registry = {}
+
+  def self.on(ev, listener_or_collection)
+    if listener_or_collection.respond_to?(:each)
+      listener_or_collection.map do |listener|
+        add_listener(@registry, ev.to_sym, listener)
+      end
+    else
+      add_listener(@registry, ev.to_sym, listener_or_collection)
+    end
+  end
+
+  def self.notify(ev, args)
+    apply_callback("on_#{ev}", args, @registry[ev.to_sym])
+  end
+
+  def self.reset
+    @registry = {}
+  end
+
+  def self.add_listener(registry, ev, listener)
+    queue = registry[ev]
+    if queue
+      queue << listener
+    else
+      registry[ev] = [listener]
+    end
+  end
+
+  def self.apply_callback(callback, args, objs)
+    return if objs.nil?
+    objs.map do |obj|
+      obj.send(callback, args) if obj.respond_to?(callback)
+      obj.call(args) if obj.respond_to?(:call)
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: fanli
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- David Zhang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+description: 
+email:
+- daqing1986@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fanli.gemspec
+- lib/fanli.rb
+- lib/fanli/base.rb
+- lib/fanli/version.rb
+homepage: http://github.com/daqing/fanli
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Fanli helps you doing business (logic)
+test_files: []