polist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d15ac52b24c1883fb0451e9fbe6f9b2d39ae90b
+  data.tar.gz: 7f25436cea33059f9eb79f81dc54e34ddade7631
+SHA512:
+  metadata.gz: d6d28e8018957ebdab190abba767b3cd08872478337a5a839190335be2f1eb89c9ac8c4e8f6b11d06f292710b5901e21acd294a51167ccf00364484a03824c00
+  data.tar.gz: 122c0fe7ac27d0c2153f4a74dcf5f191b9b545534c25dfad6b45910bd17a4f69ee1b003cebbdd6ea4bf72489b37cf5c52d0823dff66094e806692624d652f4a0

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,206 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
+  Exclude:
+    - polist.gemspec
+
+
+# Layout
+
+Layout/AlignParameters:
+  Enabled: true
+
+# Layout/MultilineMethodCallIndentation:
+#   Enabled: false
+
+# Layout/MultilineOperationIndentation:
+#   Enabled: false
+
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space
+
+Layout/SpaceInsideBrackets:
+  Enabled: false
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+# Lint
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Lint/NonLocalExitFromIterator:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Lint/RescueType:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Lint/ScriptPermission:
+  Enabled: true
+
+# Metrics
+
+# Metrics/AbcSize:
+#   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+# Metrics/ClassLength:
+#   Enabled: false
+
+# Metrics/CyclomaticComplexity:
+#   Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# Performance
+
+Performance/Caller:
+  Enabled: true
+
+Performance/Casecmp:
+  Enabled: false
+
+# Security
+
+Security/YAMLLoad:
+  Enabled: false
+
+# Style
+
+Style/AccessorMethodName:
+  # This cop assumes every method is accessor
+  Enabled: false
+
+Style/AndOr:
+  # `do_something and return`
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  # Enable it in non-rails projects with EnforcedStyle you prefer
+  Enabled: false
+
+Style/CommentAnnotation:
+  # Also, i think that better to use yard's `@todo` and other in ruby code
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  # Always return booleans in predicates
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - Rakefile
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Style/MultipleComparison:
+  Enabled: true
+
+Style/NumericLiterals:
+  Description: 'Use indent in groups of 3 unlesss you meet project-specific rule'
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: true
+
+Style/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Style/RaiseArgs:
+  Description: 'Use `raise, ErrorClass` in all cases but not when you need ErrorClass constructor'
+  Enabled: false
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false
+
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrivialAccessors:
+  AllowPredicates: true
+  Enabled: false
+
+Style/YodaCondition:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in polist.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuri Smirnov
+
+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,83 @@
+# Polist
+
+`Polist::Service` is a simple class designed for creating service classes.
+
+### Basic usage example
+```
+class MyService < Polist::Service
+  def call
+    if params[:ok]
+      success!(code: :cool)
+    else
+      fail!(code: :not_cool)
+    end
+  end
+end
+
+service = MyService.run(ok: true)
+service.success? #=> true
+service.response #=> { code: :cool }
+
+service = MyService.run(ok: false)
+service.success? #=> false
+service.response #=> { code: :not_cool }
+```
+
+The only parameter that is passed to the service is called `params` by default. If you want more params, feel free to define your own initializer and call the service accordingly:
+
+```
+class MyService < Polist::Service
+  def initialize(a, b, c)
+    # ...
+  end
+end
+
+MyService.call(1, 2, 3)
+```
+
+Unlike `.run`, `.call` will raise `Polist::Service::Failure` exception on failure:
+
+```
+begin
+  MyService.call(ok: false)
+rescue Polist::Service::Failure => error
+  error.response #=> { code: :not_cool }
+end
+```
+
+Note that `.run` and `.call` are just shortcuts for `MyService.new(...).run` and `MyService.new(...).call` with the only difference that they always return the service instance instead of the result of `#run` or `#call`. Unlike `#call` though, `#run` is not intended to be owerwritten in subclasses.
+
+### Using Form objects
+Sometimes you want to use some kind of params parsing and/or validation, and you can do that with the help of `Polist::Service::Form` class. It uses [tainbox](https://github.com/enthrops/tainbox) gem under the hood.
+
+```
+class MyService < Polist::Service
+  class Form < Polist::Service::Form
+    attribute :param1, :String
+    attribute :param2, :Integer
+    attribute :param3, :String, default: "smth"
+    attribute :param4, :String
+
+    validates :param4, presence: true
+  end
+
+  def call
+    p form.valid?
+    p [form.param1, form.param2, form.param3]
+  end
+
+  # The commented code is just the default implementation and can be simply overwritten
+  # private
+
+  # def form
+  #   @form ||= self.class::Form.new(form_attributes.to_snake_keys)
+  # end
+
+  # def form_attributes
+  #   params
+  # end
+end
+
+MyService.call(param1: "1", param2: "2") # prints false and then ["1", 2, "smth"]
+```
+The `#form` method is there just for convinience and by default it uses what `#form_attributes` returns as the attributes for the default form class which is the services' `Form` class. You are free to use as many different form classes as you want in your service.

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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "polist"
+
+# 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/lib/polist.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "polist/service"
+require "polist/version"
+
+module Polist
+end

data/lib/polist/service.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "active_model/validations"
+require "plissken"
+require "tainbox"
+
+class Polist::Service
+  class Failure < StandardError
+    attr_accessor :response
+
+    def initialize(response)
+      self.response = response
+      super
+    end
+  end
+
+  class Form
+    include Tainbox
+    include ActiveModel::Validations
+  end
+
+  attr_accessor :params
+
+  def self.call(*args)
+    build(*args).tap(&:call)
+  end
+
+  def self.run(*args)
+    build(*args).tap(&:run)
+  end
+
+  def self.param(*names)
+    names.each do |name|
+      define_method(name) { params.fetch(name) }
+    end
+  end
+
+  def initialize(params)
+    self.params = params
+  end
+
+  def call; end # Should be implemented in subclasses
+
+  def run
+    call
+  rescue Failure => error
+    @response = error.response
+    @failure = true
+  end
+
+  def response
+    @response ||= {}
+  end
+
+  def failure?
+    !!@failure
+  end
+
+  def success?
+    !failure?
+  end
+
+  def validate!
+    error!(form.errors.to_h.values.first) unless form.valid?
+  end
+
+  private
+
+  def form
+    @form ||= self.class::Form.new(form_attributes.to_snake_keys)
+  end
+
+  def form_attributes
+    params
+  end
+
+  def fail!(response = {})
+    raise self.class::Failure.new(response)
+  end
+
+  def error!(message = "")
+    fail!(error: message)
+  end
+
+  def success!(response = {})
+    @response = response
+  end
+end

data/lib/polist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Polist
+  VERSION = "0.1.0"
+end

data/polist.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "polist/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "polist"
+  spec.version       = Polist::VERSION
+  spec.authors       = ["Yuri Smirnov"]
+  spec.email         = ["tycooon@yandex.ru"]
+
+  spec.summary       = "A gem for creating simple service classes."
+  spec.description   = "Polist is a gem for creating simple service classes."
+  spec.homepage      = "https://github.com/umbrellio/polist"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "tainbox"
+  spec.add_runtime_dependency "plissken", ">= 0.3"
+  spec.add_runtime_dependency "activemodel", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: polist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuri Smirnov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tainbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: plissken
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Polist is a gem for creating simple service classes.
+email:
+- tycooon@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/polist.rb
+- lib/polist/service.rb
+- lib/polist/version.rb
+- polist.gemspec
+homepage: https://github.com/umbrellio/polist
+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.12
+signing_key: 
+specification_version: 4
+summary: A gem for creating simple service classes.
+test_files: []
+has_rdoc: