service_packer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfc85d2aec7af6ef5fdbcc3ca1bc4aec7b5fe650
+  data.tar.gz: 1af314b27ac45e92b48b8417db599255f0ded9e2
+SHA512:
+  metadata.gz: da1d49ab76ffabde6366dada3a566027c875457fd73b8d2568f6234db7c9cc4e07bbb821d4e8a2608b66c0e1481df64053ae59146dac520df288229a9eb5f6f8
+  data.tar.gz: c1724348cf5dff4bb3632f84da8b4c709de1e7dbcfc5c4535266b077c7dd3df43740b138282d95542b9c653483fca47f1e608b33e6a8f298164d3643e70a9470

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

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 parker@shundaojia.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 service_packer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 parker
+
+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,79 @@
+# ServicePacker
+
+[![Build Status](https://travis-ci.org/FX-HAO/service_packer.svg?branch=master)](https://travis-ci.org/FX-HAO/service_packer)
+
+This gem is for decoupling your logic from models, some actions in a system warrant a Service Object to encapsulate their operation(e.g. notifications, emails, feedbacks, etc). 
+Service packer provides a series of methods to standardize the process of many common behaviors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'service_packer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service_packer
+
+## Usage
+
+Here is a list with all the available behaviors, listed in the same order in which they will get called during the respective operations.
+
+**The operation life cycle**
+
+  - validation
+  - action
+  - callback
+  
+A simple example:
+
+```ruby
+class Service < ServicePacker::Base
+
+  def initialize(ride)
+    @ride = ride
+  end
+
+  setup :send, :params => [:driver] do
+    validation_define do |driver|
+      unless ride.may_send?
+        ride.errors.add(:base, :cannot_be_assigned)
+      end
+      ride
+    end
+
+    action_define do |driver|
+      ride.send(driver)
+    end
+
+    callback_define do |driver|
+      Notifier.send_to(driver, "New ride")
+    end
+  end
+
+  attr_reader :ride
+
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/FX-HAO/service_packer. 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "service_packer"
+
+# 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

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/lib/service_packer/base.rb

@@ -0,0 +1,31 @@
+require 'logger'
+
+module ServicePacker
+  class Base
+    module ClassMethods
+      def inherited(base)
+        ServicePackerStore.register(base)
+
+        super
+      end
+
+      def service_packer
+        ServicePackerStore.fetch(self)
+      end
+
+      def setup(method_name, *args, &block)
+        kwargs = args[-1].is_a?(Hash) ? args[-1] : {}
+        params = kwargs[:params] || []
+        service = service_packer
+        service.set_method_name(method_name) { service.instance_exec(&block) }
+        define_method(method_name) do |*args|
+          raise ArgumentError, "wrong number of arguments (given #{args.size}, expected #{params.size})" if args.size != params.size
+          service.invoke(self, method_name, *args)
+        end
+      end
+    end
+
+    extend ClassMethods
+
+  end
+end

data/lib/service_packer/configuration.rb

@@ -0,0 +1,6 @@
+module ServicePacker
+  class Configuration
+    # Configure a logger, with default being a Logger to STDERR
+    attr_accessor :logger
+  end
+end

data/lib/service_packer/core/action.rb

@@ -0,0 +1,16 @@
+module ServicePacker::Core
+  class Action
+    def initialize(name, *args, &block)
+      @name = name
+      @args = args
+      @block = block
+    end
+
+    def invoke(record, *args)
+      record.instance_exec(*args, &block)
+    end
+
+    attr_reader :name, :args, :block
+
+  end
+end

data/lib/service_packer/core/callback.rb

@@ -0,0 +1,16 @@
+module ServicePacker::Core
+  class Callback
+    def initialize(name, *args, &block)
+      @name = name
+      @args = args
+      @block = block
+    end
+
+    def invoke(record, *args)
+      record.instance_exec(*args, &block)
+    end
+
+    attr_reader :name, :args, :block
+
+  end
+end

data/lib/service_packer/core/validation.rb

@@ -0,0 +1,16 @@
+module ServicePacker::Core
+  class Validation
+    def initialize(name, *args, &block)
+      @name = name
+      @args = args
+      @block = block
+    end
+
+    def invoke(record, *args)
+      record.instance_exec(*args, &block)
+    end
+
+    attr_reader :name, :args, :block
+
+  end
+end

data/lib/service_packer/service.rb

@@ -0,0 +1,65 @@
+module ServicePacker
+  class Service
+    def initialize
+      @validations = {}
+      @actions = {}
+      @callbacks = {}
+      @config = ServicePacker::Configuration.new
+
+      @method_name = nil
+    end
+
+    def set_method_name(name, &block)
+      @method_name = name
+      validation_define { true }
+      action_define { true }
+      callback_define { true }
+      block.call if block_given?
+      @method_name = nil
+    end
+
+    def validation_define(*args, &block)
+      add_validation(@method_name, *args, &block)
+    end
+    
+    def action_define(*args, &block)
+      add_action(@method_name, *args, &block)
+    end
+
+    def callback_define(*args, &block)
+      add_callback(@method_name, *args, &block)
+    end
+
+    def invoke(record, name, *args)
+      validation_result = @validations[name].invoke(record, *args)
+
+      if (validation_result.respond_to?(:errors) && validation_result.errors.empty?) || validation_result == true
+        action_result = @actions[name].invoke(record, *args)
+        if (action_result.respond_to?(:errors) && action_result.errors.empty?) || action_result == true
+          @callbacks[name].invoke(record, *args)
+          true
+        else
+          false
+        end
+      else
+        false
+      end
+    end
+
+    private
+
+    attr_reader :validations, :actions, :callbacks
+
+    def add_validation(name, *args, &block)
+      @validations[name] = ServicePacker::Core::Validation.new(name, *args, &block)
+    end
+
+    def add_action(name, *args, &block)
+      @actions[name] = ServicePacker::Core::Action.new(name, *args, &block)
+    end
+
+    def add_callback(name, *args, &block)
+      @callbacks[name] = ServicePacker::Core::Callback.new(name, *args, &block)
+    end
+  end
+end

data/lib/service_packer/service_packer.rb

@@ -0,0 +1,2 @@
+module ServicePacker
+end

data/lib/service_packer/service_packer_store.rb

@@ -0,0 +1,33 @@
+require 'concurrent'
+
+module ServicePacker
+  class ServicePackerStore
+    @stores = Concurrent::Map.new
+
+    class << self
+      def stores
+        @stores
+      end
+
+      def register(klass, override = false)
+        raise "Cannot register #{klass}" unless klass.is_a?(Class)
+
+        case override
+          when FalseClass then stores[klass.to_s] ||= ServicePacker::Service.new
+          when TrueClass then stores[klass.to_s] = ServicePacker::Service.new
+          else raise "Don't know how to do with #{override}"
+        end
+      end
+      alias_method :[]=, :register
+
+      def fetch(klass)
+        stores[klass.to_s]
+      end
+      alias_method :[], :fetch
+
+      def unregister(klass)
+        stores.delete(klass.to_s)
+      end
+    end
+  end
+end

data/lib/service_packer/version.rb

@@ -0,0 +1,3 @@
+module ServicePacker
+  VERSION = "0.0.2"
+end

data/lib/service_packer.rb

@@ -0,0 +1,9 @@
+require "service_packer/version"
+require "service_packer/core/action"
+require "service_packer/core/callback"
+require "service_packer/core/validation"
+require "service_packer/configuration"
+require "service_packer/service"
+require "service_packer/base"
+require "service_packer/service_packer_store"
+require "service_packer/service_packer"

data/service_packer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_packer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "service_packer"
+  spec.version       = ServicePacker::VERSION
+  spec.authors       = ["fuxin"]
+  spec.email         = ["haofxpro@gmail.com"]
+
+  spec.summary       = "Decouple logic from Model-layer"
+  spec.description   = "Extract common behaviors into a service, and standandize the processing of services."
+  spec.homepage      = "https://github.com/FX-HAO/service_packer/"
+  spec.license       = "MIT"
+
+  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_dependency 'concurrent-ruby', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: service_packer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- fuxin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extract common behaviors into a service, and standandize the processing
+  of services.
+email:
+- haofxpro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/service_packer.rb
+- lib/service_packer/base.rb
+- lib/service_packer/configuration.rb
+- lib/service_packer/core/action.rb
+- lib/service_packer/core/callback.rb
+- lib/service_packer/core/validation.rb
+- lib/service_packer/service.rb
+- lib/service_packer/service_packer.rb
+- lib/service_packer/service_packer_store.rb
+- lib/service_packer/version.rb
+- service_packer.gemspec
+homepage: https://github.com/FX-HAO/service_packer/
+licenses:
+- MIT
+metadata: {}
+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.8
+signing_key: 
+specification_version: 4
+summary: Decouple logic from Model-layer
+test_files: []