fanli 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a443bfa0dd9e8f717bf346d5d27579c26c217454
4
+ data.tar.gz: e89db1278142a0005795374d4c0f68dbe12cb9a2
5
+ SHA512:
6
+ metadata.gz: 79f34296eafc6cccd14438dcb09c00f28249cafb06775323ce785865334e44474ec0f2195bfdb4bc00134dc18982410c748e85787a087b22758ee6ecb9c85136
7
+ data.tar.gz: d415c741ac7d660435bd0c3bb550a497e3f9c02ec334398313d51ac0c9f1ab7935279876be495e6bc4ac2be3a9235c2bfef8f56a0b934a5916f8e1d20d39308b
data/.gitignore ADDED
@@ -0,0 +1,18 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
13
+ .byebug_history
14
+ *.gem
15
+ GPATH
16
+ GRTAGS
17
+ GTAGS
18
+ .DS_Store
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.4.1
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.3
5
+ before_install: gem install bundler -v 1.14.6
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at daqing1986@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in fanli.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 David Zhang
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,137 @@
1
+ # Fanli
2
+
3
+ Fanli is a new way to implement **complex** business logic in your application(e.g. Rails).
4
+
5
+ 范蠡, 是实现复杂业务逻辑的一种新思路。(如果你的Rails model超过了200行代码,也许你该试试它~~)
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'fanli'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install fanli
22
+
23
+ ## Usage
24
+
25
+ > Assume you run an ecommerce site, and you may want to do the following things
26
+ > after user registeration:
27
+ >
28
+ > 1. Send welcome email
29
+ > 2. Give 20% off coupon if its xmas
30
+ > 3. Give $5 cash if he's from Beijing
31
+ > 4. And many more business rules in the future...
32
+
33
+ Following "The Rails Way", you may implement these rules **ALL** in the `User` model like this:
34
+
35
+ ```ruby
36
+ class User < ActiveRecord::Base
37
+ validates :name, :email, presence: true
38
+
39
+ after_create :send_welcome_email
40
+ after_create :give_coupon_if_xmas
41
+ after_create :give_initial_cash
42
+
43
+ # add more `after_commit` callbacks...
44
+
45
+ private
46
+
47
+ def send_welcome_email
48
+ # business logic goes here...
49
+ end
50
+
51
+ def give_coupon_if_xmas
52
+ # business logic goes here...
53
+ end
54
+
55
+ def give_initial_cash
56
+ # business logic goes here...
57
+ end
58
+ end
59
+ ```
60
+ This will result in "Fat Models" that violate the SRP("[Single responsibility principle](https://en.wikipedia.org/wiki/Single_responsibility_principle)").
61
+
62
+ To solve this problem and prevent messy code, you should write code in "The Fanli Way":
63
+
64
+ 1. Create a new folder containing all the business code:
65
+
66
+ ```bash
67
+ $ cd [/path/to/your/rails_project]
68
+ $ mkdir app/business
69
+ ```
70
+
71
+ 2. Create a new "business processing class":
72
+
73
+ ```ruby
74
+ # app/business/create_user.rb
75
+ class CreateUser < Fanli::Base
76
+ def perform(args)
77
+ User.create!(args)
78
+ end
79
+ end
80
+ ```
81
+
82
+ 3. Implement each business login using separate "Plain Old Ruby Class":
83
+
84
+ ```ruby
85
+ # app/business/send_welcome_email.rb
86
+ class SendWelcomeEmail
87
+ def self.on_create_user(args)
88
+ # business logic goes here...
89
+ end
90
+ end
91
+ ```
92
+
93
+ ```ruby
94
+ # app/business/give_coupon_if_xmas.rb
95
+ class GiveCouponIfXmas
96
+ def self.on_create_user(args)
97
+ # business logic goes here...
98
+ end
99
+ end
100
+ ```
101
+
102
+ ```
103
+ # app/business/give_initial_cash.rb
104
+ class GiveInitialCash
105
+ def self.on_create_user(args)
106
+ # business logic goes here...
107
+ end
108
+ end
109
+ ```
110
+
111
+ 4. Register each business logic class:
112
+
113
+ ```ruby
114
+ # config/initializers/business.rb
115
+ Fanli.on(:create_user, [
116
+ SendWelcomeEmail,
117
+ GiveCouponIfXmas,
118
+ GiveInitialCash
119
+ ])
120
+ ```
121
+ 5. Done! Enjoy!
122
+
123
+ ## Development
124
+
125
+ 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.
126
+
127
+ 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).
128
+
129
+ ## Contributing
130
+
131
+ 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.
132
+
133
+
134
+ ## License
135
+
136
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
137
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "fanli"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/fanli.gemspec ADDED
@@ -0,0 +1,36 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'fanli/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "fanli"
8
+ spec.version = Fanli::VERSION
9
+ spec.authors = ["David Zhang"]
10
+ spec.email = ["daqing1986@gmail.com"]
11
+
12
+ spec.summary = %q{Fanli helps you doing business (logic)}
13
+ spec.homepage = "http://github.com/daqing/fanli"
14
+ spec.license = "MIT"
15
+
16
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
17
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
18
+ if spec.respond_to?(:metadata)
19
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
20
+ else
21
+ raise "RubyGems 2.0 or newer is required to protect against " \
22
+ "public gem pushes."
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
26
+ f.match(%r{^(test|spec|features)/})
27
+ end
28
+ spec.bindir = "exe"
29
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
30
+ spec.require_paths = ["lib"]
31
+
32
+ spec.add_development_dependency "bundler", "~> 1.14"
33
+ spec.add_development_dependency "rake", "~> 10.0"
34
+ spec.add_development_dependency "rspec", "~> 3.0"
35
+ spec.add_development_dependency "byebug", "~> 9"
36
+ end
data/lib/fanli/base.rb ADDED
@@ -0,0 +1,30 @@
1
+ module Fanli
2
+ class Base
3
+ def self.inherited(sub)
4
+ sub.extend(ClassMethods)
5
+ end
6
+
7
+ def perform(*_args)
8
+ throw(:please_create_your_own_perform_method)
9
+ end
10
+
11
+ module ClassMethods
12
+ def do(opts)
13
+ obj = new
14
+ obj.perform(opts)
15
+ Fanli.notify(snikize(name), opts)
16
+ end
17
+
18
+ private
19
+
20
+ def snikize(str)
21
+ return '' if str.nil?
22
+ str.gsub(/::/, '/')
23
+ .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
24
+ .gsub(/([a-z\d])([A-Z])/, '\1_\2')
25
+ .tr('-', '_')
26
+ .downcase
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,3 @@
1
+ module Fanli
2
+ VERSION = "0.1.2"
3
+ end
data/lib/fanli.rb ADDED
@@ -0,0 +1,42 @@
1
+ require 'fanli/version'
2
+ require 'fanli/base'
3
+
4
+ # Fanli
5
+ module Fanli
6
+ @registry = {}
7
+
8
+ def self.on(ev, listener_or_collection)
9
+ if listener_or_collection.respond_to?(:each)
10
+ listener_or_collection.map do |listener|
11
+ add_listener(@registry, ev.to_sym, listener)
12
+ end
13
+ else
14
+ add_listener(@registry, ev.to_sym, listener_or_collection)
15
+ end
16
+ end
17
+
18
+ def self.notify(ev, args)
19
+ apply_callback("on_#{ev}", args, @registry[ev.to_sym])
20
+ end
21
+
22
+ def self.reset
23
+ @registry = {}
24
+ end
25
+
26
+ def self.add_listener(registry, ev, listener)
27
+ queue = registry[ev]
28
+ if queue
29
+ queue << listener
30
+ else
31
+ registry[ev] = [listener]
32
+ end
33
+ end
34
+
35
+ def self.apply_callback(callback, args, objs)
36
+ return if objs.nil?
37
+ objs.map do |obj|
38
+ obj.send(callback, args) if obj.respond_to?(callback)
39
+ obj.call(args) if obj.respond_to?(:call)
40
+ end
41
+ end
42
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fanli
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.2
5
+ platform: ruby
6
+ authors:
7
+ - David Zhang
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-05-05 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.14'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: byebug
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '9'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '9'
69
+ description:
70
+ email:
71
+ - daqing1986@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".ruby-version"
79
+ - ".travis.yml"
80
+ - CODE_OF_CONDUCT.md
81
+ - Gemfile
82
+ - LICENSE.txt
83
+ - README.md
84
+ - Rakefile
85
+ - bin/console
86
+ - bin/setup
87
+ - fanli.gemspec
88
+ - lib/fanli.rb
89
+ - lib/fanli/base.rb
90
+ - lib/fanli/version.rb
91
+ homepage: http://github.com/daqing/fanli
92
+ licenses:
93
+ - MIT
94
+ metadata:
95
+ allowed_push_host: https://rubygems.org
96
+ post_install_message:
97
+ rdoc_options: []
98
+ require_paths:
99
+ - lib
100
+ required_ruby_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ required_rubygems_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ requirements: []
111
+ rubyforge_project:
112
+ rubygems_version: 2.6.11
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: Fanli helps you doing business (logic)
116
+ test_files: []