polist 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73c8e323de7cb71b6b39441dd95abf7fbccb8de9cb391790faf2fde7f7f4a20a
-  data.tar.gz: a281f80553b3db467785bd1a2c04701a428c8dac372658369b8ddae8b5cc22b3
+  metadata.gz: 4a3ccf0f8d1e783625a5f9b9c7f812e199fd965daba514a26e24dd17579d1324
+  data.tar.gz: 00c5fd25949bcbadcd391f526ed744428e82d657454c173a3598c196ffa50df5
 SHA512:
-  metadata.gz: 6af97512d4e3f8b135369ce37dedc444758c3d060af1df1839b80a296d2305469b4399138312f31b437d993681b726e01d54054b61d753da99ce4130a085fbef
-  data.tar.gz: 99420ff893d32b0eb1b02b498e0f51dede79054e24ef4f6282bdbb029f329e7fdebf19c6263e03c0298c44f42a8613d87b564c99e71dc88270fb07d40baaf4ec
+  metadata.gz: d037d246cbb437c7c33e58cc54f682ceaeb0a041d03e8d70f81cb8d994725d5295069dd53507af0f3e01f0d4e39356e911c578c3fd9217a53e6c127db60ac6b9
+  data.tar.gz: 657941a65cf0e2d806967663d7fd32949c96e41d35da152a9e2a95218ec4ecf374605db9df7b3584a810a897bcb7d4db84eb755bd834d81c2a81c845a8284bb2

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## [Unreleased]
+
+## [1.0.0] - 2019-02-03
+
+### Added
+
+- Add `Polist::Struct` and `Polist::Builder` ([@tycooon]) [#3]
+
+## [0.4.0] - 2017-10-31
+
+- Initial public version.
+
+[0.4.0]: https://github.com/umbrellio/polist/tree/v0.4.0
+[1.0.0]: https://github.com/umbrellio/polist/compare/v0.4.0...v1.0.0
+[Unreleased]: https://github.com/umbrellio/polist/compare/v1.0.0...HEAD
+
+[@tycooon]: https://github.com/tycooon
+
+[#3]: https://github.com/umbrellio/polist/pull/3

data/Gemfile

@@ -4,3 +4,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in polist.gemspec
 gemspec
+
+gem "rubocop-config-umbrellio", github: "umbrellio/code-style"

data/README.md

@@ -1,11 +1,17 @@
 # Polist   [![Gem Version](https://badge.fury.io/rb/polist.svg)](https://badge.fury.io/rb/polist) [![Build Status](https://travis-ci.org/umbrellio/polist.svg?branch=master)](https://travis-ci.org/umbrellio/polist) [![Coverage Status](https://coveralls.io/repos/github/umbrellio/polist/badge.svg?branch=master)](https://coveralls.io/github/umbrellio/polist?branch=master)
 
-`Polist::Service` is a simple class designed for creating service classes.
+Polist is a set of simple tools for creating business logic layer of your applications:
 
-### Installation
-Juts add `gem "polist"` to your Gemfile.
+- `Polist::Service` is a simple class designed for creating service classes.
+- `Polist::Builder` is a builder system based on `Uber::Builder`.
+- `Polist::Struct` is a small utility that helps generating simple `Struct`-like object initializers.
+
+## Installation
+
+Simply add `gem "polist"` to your Gemfile.
+
+## Using Polist::Service
 
-### Basic usage example
 ```ruby
 class MyService < Polist::Service
   def call
@@ -51,6 +57,7 @@ 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.
 
 ```ruby
@@ -83,12 +90,95 @@ 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.
 
+## Using Polist::Builder
+
+The build logic is based on [Uber::Builder](https://github.com/apotonick/uber#builder) but it allows recursive builders. See the example:
+
+Can be used with `Polist::Service` or any other Ruby class.
+
+```ruby
+class User
+  include Polist::Builder
+
+  builds do |role|
+    case role
+    when /admin/
+      Admin
+    end
+  end
+
+  attr_accessor :role
+
+  def initialize(role)
+    self.role = role
+  end
+end
+
+class Admin < User
+  builds do |role|
+    SuperAdmin if role == "super_admin"
+  end
+
+  class SuperAdmin < Admin
+    def super?
+      true
+    end
+  end
+
+  def super?
+    false
+  end
+end
+
+User.build("user") # => #<User:... @role="user">
+
+User.build("admin") # => #<Admin:... @role="admin">
+User.build("admin").super? # => false
+
+User.build("super_admin") # => #<Admin::SuperAdmin:... @role="super_admin">
+User.build("super_admin").super? # => true
+
+Admin.build("smth") # => #<Admin:... @role="admin">
+SuperAdmin.build("smth") # => #<Admin::SuperAdmin:... @role="admin">
+```
+
+## Using Polist::Struct
+
+Works pretty much the same like Ruby `Struct` class, but you don't have to subclass it.
+
+Can be used with `Polist::Service` or any other class that don't have initializer specified.
+
+```ruby
+class Point
+  include Polist::Struct
+
+  struct :x, :y
+end
+
+a = Point.new(15, 25)
+a.x # => 15
+a.y # => 25
+
+b = Point.new(15, 25, 35) # raises ArgumentError: struct size differs
+
+c = Point.new(15)
+c.x # => 15
+c.y # => nil
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/polist.
+
 ## License
+
 Released under MIT License.
 
 ## Authors
+
 Created by Yuri Smirnov.
 
 <a href="https://github.com/umbrellio/">

data/lib/polist.rb

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

data/lib/polist/builder.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "uber/builder"
+
+module Polist
+  module Builder
+    def self.included(base)
+      base.include(Uber::Builder)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Recursively runs class builders on class until no builders on that class found
+      # or some builder returns the class itself
+      def build_klass(*args)
+        klass = self
+
+        loop do
+          new_klass = klass.build!(klass, *args)
+          break if new_klass == klass
+          klass = new_klass
+        end
+
+        klass
+      end
+
+      def build(*args)
+        build_klass(*args).new(*args)
+      end
+    end
+  end
+end

data/lib/polist/struct.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Polist
+  module Struct
+    module ClassMethods
+      def struct(*attrs)
+        attr_accessor(*attrs)
+
+        define_method(:initialize) do |*args|
+          raise ArgumentError, "struct size differs" if args.length > attrs.length
+          attrs.zip(args).each { |attr, val| public_send(:"#{attr}=", val) }
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/polist/version.rb

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

data/polist.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "polist/version"
 
@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   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.summary       = "A gem for creating simple service classes and more."
+  spec.description   = "Polist is a gem for creating simple service classes and more."
   spec.homepage      = "https://github.com/umbrellio/polist"
   spec.license       = "MIT"
 
@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activemodel", ">= 3.0"
   spec.add_runtime_dependency "plissken", ">= 0.3"
   spec.add_runtime_dependency "tainbox"
+  spec.add_runtime_dependency "uber"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop-config-umbrellio"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polist
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-31 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: uber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-config-umbrellio
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Polist is a gem for creating simple service classes.
+description: Polist is a gem for creating simple service classes and more.
 email:
 - tycooon@yandex.ru
 executables: []
@@ -161,12 +161,15 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/polist.rb
+- lib/polist/builder.rb
 - lib/polist/service.rb
+- lib/polist/struct.rb
 - lib/polist/version.rb
 - polist.gemspec
 homepage: https://github.com/umbrellio/polist
@@ -188,9 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: A gem for creating simple service classes.
+summary: A gem for creating simple service classes and more.
 test_files: []