use_case_flow 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c5a199dc5fdf12df3044f1720005325a61dcc9f
+  data.tar.gz: d48040e007384cd9e7fc0c308cf42d5ea6e2049f
+SHA512:
+  metadata.gz: 1ac58aa0b07cf4f89393ef11a27e42024a8797012c897018aa5e68921ac4f25901c34016b79b518ff7cbdbb83700cc4b5640b26ad7952bac1f948f286e3603e0
+  data.tar.gz: f2754caf7f6da7774b5f39e70efe53879bf4a3472902f2383492a0bd3269e8d76d670a19f1e2dbff9ab00503d45ca40e5181a8c9aeb85b85fc3ace7057bfc814

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+      - 'bin/**'
+      - 'vendor/**/*'
+      - 'example/*'
+      - 'use_case_flow.gemspec'
+Documentation:
+   Enabled: false
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

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 galaspiotrek@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,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in use_case_flow.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Piotr
+
+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,80 @@
+[![Build Status](https://travis-ci.org/piotr-galas/use_case_flow.svg?branch=master)](https://travis-ci.org/piotr-galas/use_case_flow)
+# UseCaseFlow
+
+This gem provide easy and readable way to invoke services/use_cases in your controller
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'use_case_flow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install use_case_flow, require: false
+    
+## Intention
+    
+Controllers should take care only on things related to http, like `redirect`, `render` , `request`. `response` and so on. Writing code became much easier when we invoke our models inside service/use_cases
+ instead in controllers. Imagine code where you invoke some service and then based on result you render special template, or redirect to url and nothing more. From practical point of view we always have one success path
+ and few failures.  This gem allow very readable syntax for that case.
+ 
+
+
+## Usage
+   To create service you must:
+   -  `require use_case_flow` 
+   -  Method you invoke in controller MUST return instance of Success or Failure
+   -  As example i use `return` `if`  syntax because it is easiest way to demonstrate how doest it work. You can use other technics but method must return `Success` or `Failure` instance 
+ 
+   ```ruby
+   
+    `require use_case_flow` 
+   
+     class SomeService
+       def call # you can use different name of method 
+         return Failure.new(:name_what_was_wrong, 'data put to controller') if semething_go_wrong
+         return Failure.new(:email_is_empty, {}) if empty_email? 
+         return Failure.new(:user_not_found, User.new ) if user?
+         Success.new('data put to controller')   
+       end
+     end
+     
+     class UserController
+        
+       def create
+         result = SomeService.new.call
+         # order of line below have no matter
+         result.name_what_was_wrong { |data_from_service| render :template, json: data_from_service }
+         result.email_is_empty { |data_from_service| redirect_to 'www.example.com' }
+         result.user_not_found {|new_user| render json: new_user, status: 422}
+         result.success{ |text| render plain: text}
+       end
+     end
+   ```
+   example usage from real project, it shows how your controller could looks
+   
+    - [controller](https://github.com/piotr-galas/use_case_flow/blob/master/example/auction_controller.rb)
+    - [service](https://github.com/piotr-galas/use_case_flow/blob/master/example/archive.rb)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. Then, run `rubocop` to run the rubocop ,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/piotr-galas/use_case_flow. 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,8 @@
+# frozen_string_literal: true
+
+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 'use_case_flow'
+
+# 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/example/archive.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require use_case_flow
+
+module Auctions
+  module Standard
+    class Archive
+      def initialize(params, user)
+        @params = params
+        @user = user
+      end
+
+      def call
+        return Failure.new(:not_found, errors: :not_found) if auction.nil?
+        return Failure.new(:unauthorized, errors: :not_authorized) unless authorized?
+        return Failure.new(:not_allowed, errors: :it_is_not_published_auction) unless auction.published?
+        archive_auction
+        Success.new(auction)
+      end
+
+      private
+
+      def authorized?
+        auction.user == @user && @user.verified_success?
+      end
+
+      def auction
+        @auction ||= Auction.find_by(id: @params[:id])
+      end
+
+      def archive_auction
+        if auction.update(status: :archived)
+          auction.proposals.pending.each do |proposal|
+            Account::Proposals::Update.new({ id: proposal.id, update_action: 'end_auction' }, auction.user).execute
+          end
+        end
+      end
+    end
+  end
+end

data/example/auction_controller.rb

@@ -0,0 +1,65 @@
+class FrontApi::V1::Auction::StandardsController < FrontApi::BaseController
+  before_action do
+    self.class.serialization_scope :current_front_api_v1_user
+  end
+
+  def create
+    result = Auctions::Standard::Create.new(auction_params, current_front_api_v1_user).execute
+    result.success { |auction| render json: auction, status: :created }
+    result.locked { |errors| render json: errors, status: :locked }
+    result.invalid { |errors| render json: errors, status: :unprocessable_entity }
+    result.invalid_api { |errors| render json: errors, status: :service_unavailable }
+  end
+
+  def index
+    result = Auctions::Standard::Index.new(search_params, current_front_api_v1_user).auction_list_objects
+    result.success { |auction_list_objects| render json: auction_list_objects, status: :ok }
+  end
+
+  def show
+    result = Auctions::Standard::Show.new(params, current_front_api_v1_user).call
+    result.success { |auction| render json: auction, status: :ok }
+    result.not_found { |errors| render json: errors, status: :not_found }
+    result.not_allowed { |errors| render json: errors, status: :forbidden }
+  end
+
+  def update
+    result = Auctions::Standard::Update.new(auction_params, current_front_api_v1_user).call
+    result.success { |auction| render json: auction, status: :ok }
+    result.locked { |errors| render json: errors, status: :locked }
+    result.unauthorized { |errors| render json: errors, status: :unauthorized }
+    result.not_found { |errors| render json: errors, status: :not_found }
+    result.not_allowed { |errors| render json: errors, status: :forbidden }
+    result.invalid { |errors| render json: errors, status: :unprocessable_entity }
+  end
+
+  def renew
+    result = Auctions::Standard::Renew.new(auction_params, current_front_api_v1_user).call
+    result.success { render json: {}, status: :ok }
+    result.not_found { |errors| render json: errors, status: :not_found }
+    result.invalid_duration { |errors| render json: errors, status: :unprocessable_entity }
+    result.not_published { |errors| render json: errors, status: :forbidden }
+    result.unauthorized { |errors| render json: errors, status: :unauthorized }
+    result.locked { |errors| render json: errors, status: :locked }
+    result.invalid_api { |errors| render json: errors, status: :service_unavailable }
+  end
+
+  def archive
+    result = Auctions::Standard::Archive.new(auction_params, current_front_api_v1_user).call
+    result.success { |auction| render json: auction, status: :ok }
+    result.unauthorized { |errors| render json: errors, status: :unauthorized }
+    result.not_found { |errors| render json: errors, status: :not_found }
+    result.not_allowed { |errors| render json: errors, status: :forbidden }
+    result.invalid { |errors| render json: errors, status: :unprocessable_entity }
+  end
+
+  private
+
+  def search_params
+    params.permit(:query, :category)
+  end
+
+  def auction_params
+    params.permit(:id, :status)
+  end
+end

data/lib/use_case_flow.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'use_case_flow/version'
+require 'use_case_flow/result'

data/lib/use_case_flow/result.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module UseCaseFlow
+  class Result
+    attr_reader :name
+
+    def initialize(name, *args)
+      @name = name
+      @args = args
+      @was_called = false
+
+      define_singleton_method(name) do |&block|
+        block.call(*@args)
+        @was_called = true
+      end
+
+      define_singleton_method("#{name}?") do
+        true
+      end
+    end
+
+    def else
+      yield unless @was_called
+    end
+
+    def else_fail!
+      self.else { raise "unhandled Result '#{@name}' with args: #{@args.inspect}" }
+    end
+
+    # rubocop:disable Style/MethodMissing
+    def method_missing(_method_name, *_args, &_block)
+      false
+    end
+
+    def values
+      @args
+    end
+
+    def value
+      @args.first
+    end
+  end
+end
+
+class Success < UseCaseFlow::Result
+  def initialize(*args)
+    super(:success, *args)
+  end
+end
+
+class Failure < UseCaseFlow::Result
+  def failure?
+    true
+  end
+end

data/lib/use_case_flow/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UseCaseFlow
+  VERSION = '1.0.0'
+end

data/use_case_flow.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'use_case_flow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'use_case_flow'
+  spec.version       = UseCaseFlow::VERSION
+  spec.authors       = ['Piotr']
+  spec.email         = ['galaspiotrek@gmail.com']
+
+  spec.summary       = 'It provide readable control flow for use cases / services'
+  spec.description   = 'You can use it in controller as a layer betwen controller and model'
+  spec.homepage      = 'https://github.com/piotr-galas/use_case_flow'
+  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.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: use_case_flow
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Piotr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-23 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !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'
+description: You can use it in controller as a layer betwen controller and model
+email:
+- galaspiotrek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/archive.rb
+- example/auction_controller.rb
+- lib/use_case_flow.rb
+- lib/use_case_flow/result.rb
+- lib/use_case_flow/version.rb
+- use_case_flow.gemspec
+homepage: https://github.com/piotr-galas/use_case_flow
+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.11
+signing_key: 
+specification_version: 4
+summary: It provide readable control flow for use cases / services
+test_files: []