light_services 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30c9c842a952e3a04bef9a44dcccdaa9ff545ebe
+  data.tar.gz: e7da3333fc8bf4a3f81b63b3436e0b7b8a632f9a
+SHA512:
+  metadata.gz: 7f4e060b32891610835ff51fcc755403308982e2e8f9370c88b73cdc350c4b74ad0a0640b598489927cd007380c18849adba1bf60ae7a7199d92b5bc3422c592
+  data.tar.gz: 7913d2912006b81c76b345543b9d0ff549a71492039905a03c38132a4069ad7e7203cdc3c9b20b1a2a6dda3597dd64ce40cd51fc9583a57216a71a35031ede25

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nicolas Lima
+
+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,131 @@
+# LightServices
+
+LightServices is a simple base to help build a service layer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'light_services'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install light_services
+
+## Usage
+
+```ruby
+
+# app/models/user.rb
+class User
+
+  attr_reader :errors
+  attr_accessor :first_name, :last_name, :errors
+
+  def initialize(first_name, last_name)
+    @first_name = first_name
+    @last_name  = last_name
+    @errors     = []
+  end
+
+  def save
+    puts "saving in some db..."
+  end
+
+  def add_errors(message)
+    @errors.push message 
+  end
+end
+
+# app/services/user_creator.rb
+class UserCreator < LightServices::Service
+
+  attributes :first_name, :last_name
+  validates  :first_name, :last_name, presence: true
+  execute    :create_user, if: :input_valid?, fallback: :add_error
+  
+  returns User do |user|
+    @user = user.new @first_name, @last_name
+  end
+
+  def create_user
+    @user.save
+    # ... other complexity logic
+  end
+
+  def add_error
+    @user.add_errors( "Opss, something it's wrong" )
+  end
+
+end
+
+user = UserCreator.new(first_name: 'Aragorn II', last_name: 'son of Arathorn').call
+
+```
+
+### API doc
+
+* **attributes**
+
+`attributes` defines service inputs and will declares a instance variabel with the same name.
+You need pass the keywords from `initialize` like:
+
+```ruby
+
+### hello_world_service.rb
+attributes :name # declares @name 
+
+### hello_world_controller.rb
+HelloWorldService.new(name: 'Aragorn')
+```
+
+* **validates**
+
+`validates` is from ActiveModel::Validations
+
+* **execute**
+
+`execute` delegates which method will be called when the `#call` is invoked.
+
+*options*
+
+  `if:` - validation method, you can override it or pass other method (need returns boolean value)
+
+  `fallback:` - is invoked when the validations method isn't valid
+
+* **returns**
+
+declares what will be returned.
+You can access `returns` through the instance variable with the same name.
+
+`returns` accept block to initialize the returns e.g.
+
+```ruby
+#hello_world_service.rb
+
+returns User do |user|
+  @user = user.new
+end
+```
+
+## 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/nicolaslima/light_services.
+
+
+## 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 "light_services"
+
+# 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/examples/hello_world.rb

@@ -0,0 +1,43 @@
+class User
+
+  attr_reader :errors
+  attr_accessor :first_name, :last_name, :errors
+
+  def initialize(first_name, last_name)
+    @first_name = first_name
+    @last_name  = last_name
+    @errors     = []
+  end
+
+  def save
+    puts "saving in some db..."
+  end
+
+  def add_errors(message)
+    @errors.push message 
+  end
+end
+
+
+class UserCreator < LightServices::Service
+
+  attributes :first_name, :last_name
+  validates  :first_name, :last_name, presence: true
+  execute    :create_user, if: :input_valid?, fallback: :add_error
+  
+  returns User do |user|
+    @user = user.new @first_name, @last_name
+  end
+
+  def create_user
+    @user.save
+    # ... other complexity logic
+  end
+
+  def add_error
+    @user.add_errors( "Opss, something it's wrong" )
+  end
+
+end
+
+user = UserCreator.new(first_name: 'Aragorn II', last_name: 'son of Arathorn').call

data/lib/light_services/base.rb

@@ -0,0 +1,90 @@
+module LightServices
+  module Base
+
+    module ClassMethods
+      def attributes(*args)
+        define_class_attributes(args)
+        @attributes = args
+      end
+
+      def get_attributes
+        @attributes || {}
+      end
+
+      def returns(resource, &block)
+        @returns = resource
+        @returns_block = block if block_given?
+      end
+
+      def get_returns
+        @returns || ''
+      end
+
+      def get_returns_block
+        @returns_block
+      end
+
+      def execute(method_name, options = {})
+        @method_name     = method_name
+        @execute_options = { if: options[:if], fallback: options[:fallback] }
+      end
+
+      def get_execute_method_name
+        @method_name
+      end
+
+      def get_execute_method_options
+        @execute_options
+      end
+
+      def define_class_attributes(attributes)
+        attributes.map do |attr_name|
+          send(:attr_reader, attr_name)
+        end
+      end
+    end
+
+    module InstanceMethods
+      def attributes
+        self.class.get_attributes
+      end
+
+      def returns
+        self.class.get_returns
+      end
+
+      def returns_name
+        self.class.get_returns.to_s.downcase
+      end
+
+      def returns_block
+        self.class.get_returns_block
+      end
+
+      def execute_method_name
+        self.class.get_execute_method_name
+      end
+
+      def execute_method_options
+        self.class.get_execute_method_options
+      end
+
+      def initialize_class_attributes(args)
+        args[0].map do |attr_name, value|
+          if attributes.include? attr_name
+            instance_variable_set("@#{ attr_name }", value)
+          end
+        end
+      end
+
+      def initialize_returns_attribute
+        instance_variable_set("@#{ returns_name }", returns)
+      end
+
+      def setup_returns
+        self.instance_exec( returns, &returns_block )
+      end
+    end
+
+  end
+end

data/lib/light_services/service.rb

@@ -0,0 +1,54 @@
+require 'active_model'
+
+module LightServices
+  class Service
+    include ActiveModel::Validations
+    include LightServices::Base::InstanceMethods
+    extend  LightServices::Base::ClassMethods
+
+    alias :input_valid? :valid?
+
+    def initialize(*args)
+      validate_arguments(args)
+      initialize_class_attributes(args)
+      initialize_returns_attribute if has_returns?
+      setup_returns if returns_block
+    end
+
+    def call
+      if has_conditional?
+        executed_method_return = validate_conditional
+      else
+        executed_method_return = send( execute_method_name )
+      end
+      
+      has_returns? ? instance_variable_get("@#{ returns_name }") : executed_method_return
+    end
+
+    private
+
+      def has_returns?
+        !returns.nil?
+      end
+
+      def has_conditional?
+        !execute_method_options[:if].nil? && !execute_method_options[:if].empty?
+      end
+
+      def validate_conditional
+        conditional_pass = send( execute_method_options[:if] )
+        
+        if conditional_pass
+          send( execute_method_name )
+        else
+          send( execute_method_options[:fallback] ) if execute_method_options[:fallback]
+        end
+      end
+
+      def validate_arguments(args)
+        raise InvalidArgumentError, "Arguments required, but was given a #{args.class}" if args.empty?
+        raise InvalidArgumentError, "keyword arguments are required" if args[0].class != Hash
+      end
+
+  end
+end

data/lib/light_services/version.rb

@@ -0,0 +1,3 @@
+module LightServices
+  VERSION = "0.1.0"
+end

data/lib/light_services.rb

@@ -0,0 +1,6 @@
+require "light_services/version"
+require "light_services/base"
+require "light_services/service"
+
+module LightServices
+end

data/light_services.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'light_services/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "light_services"
+  spec.version       = LightServices::VERSION
+  spec.authors       = ["Nicolas Lima"]
+  spec.email         = ["lima.nicolasmateus@gmail.com"]
+
+  spec.summary       = %q{A simple base to help build Services}
+  spec.description   = %q{A simple base to help build Services}
+  spec.homepage      = "https://github.com/nicolaslima/light_services"
+  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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "activemodel", "4.2.6"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: light_services
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Lima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-03 00:00:00.000000000 Z
+dependencies:
+- !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: '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: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+description: A simple base to help build Services
+email:
+- lima.nicolasmateus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/hello_world.rb
+- lib/light_services.rb
+- lib/light_services/base.rb
+- lib/light_services/service.rb
+- lib/light_services/version.rb
+- light_services.gemspec
+homepage: https://github.com/nicolaslima/light_services
+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: A simple base to help build Services
+test_files: []