shale-builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7749b75b69a25526581d8b071fd93b44a7b6d9cc1a953fec8fbb0815fe3d86a
+  data.tar.gz: 30ce0be01b5290da4a5960c1993f3372edc251209477205fcedeb0cc0f4fabd9
+SHA512:
+  metadata.gz: 5f846398c26ed0afa0641bb9a912f357d446082ff11d71b738027916c4af16561f8767898d002b3f8af5396fe5f47d1ba31dc6bb3f75e22d847ae41e432ab337
+  data.tar.gz: 960fa9d1138ce59b5d859659b5aa713f263831328105d73ee403a631a4fbfe1c3ea34c758a4cecd10d9b01ab5d16db3016aecd2abe6960e3c0ca71cecb095915

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rubocop-espago: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in diggable.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0' # test framework
+gem 'rake', '~> 13.0' # automation tasks
+gem 'rubocop-espago', '~> 1.0' # ruby linter
+gem 'shoulda-context', '~> 2.0' # more pleasant test syntax
+gem 'solargraph', '~> 0.48'  # language server

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    shale-builder (0.1.0)
+      shale (< 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    minitest (5.17.0)
+    nokogiri (1.14.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-espago (1.0.2)
+      rubocop
+    ruby-progressbar (1.11.0)
+    shale (0.9.0)
+    shoulda-context (2.0.0)
+    solargraph (0.48.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.1.0)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop-espago (~> 1.0)
+  shale-builder!
+  shoulda-context (~> 2.0)
+  solargraph (~> 0.48)
+
+BUNDLED WITH
+   2.4.7

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mateusz Drewniak
+
+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,179 @@
+# Shale::Builder
+
+This addon to the [shale](https://github.com/kgiszczak/shale) Ruby gem adds a simple yet powerful builder DSL.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add shale-builder
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install shale-builder
+
+## Usage
+
+### TLDR
+
+Build your [shale](https://github.com/kgiszczak/shale) classes like a boss.
+
+```rb
+transaction = Transaction.build do |t|
+    t.cvv_code = '123'
+    t.amount do |a|
+        a.value = 2.3
+        a.currency = 'PLN'
+    end
+    t.payment_instrument do |p|
+        p.number = '4242424242424242'
+        p.expiration_year = 2045
+        p.expiration_month = 12
+    end
+end
+```
+
+### Build method
+
+This gem adds a module named `Shale::Builder`. It's meant to be included
+in subclasses of `Shale::Mapper` to provide an easier way of building
+instances.
+
+You can use it like that:
+
+```rb
+require 'shale/builder'
+
+class Amount < Shale::Mapper
+    include Shale::Builder
+
+    attribute :value, Shale::Type::Float
+    attribute :currency, Shale::Type::String
+end
+```
+
+Now instead of creating an instance like that:
+
+```rb
+amount = Amount.new(value: 2.3, currency: 'PLN')
+```
+
+You can do it like that:
+
+```rb
+amount = Amount.build do |a|
+    a.value = 2.3
+    a.currency = 'PLN'
+end
+```
+
+### Building nested objects
+
+It's kind of pointless when you've got a flat structure.
+It really shines when nested objects come into play.
+
+Let's say that you've got a structure like this:
+
+```rb
+class Amount < Shale::Mapper
+    include Shale::Builder
+
+    attribute :value, Shale::Type::Float
+    attribute :currency, Shale::Type::String
+end
+
+class PaymentInstrument < Shale::Mapper
+    include Shale::Builder
+
+    attribute :number, Shale::Type::String
+    attribute :expiration_year, ::Shale::Type::Integer
+    attribute :expiration_month, ::Shale::Type::Integer
+end
+
+class Transaction < ::Shale::Mapper
+    include Shale::Builder
+
+    attribute :cvv_code, Shale::Type::String
+    attribute :amount, Amount
+    attribute :payment_instrument, PaymentInstrument
+end
+```
+
+Normally you would instantiate it like that:
+
+```rb
+transaction = Transaction.new(
+    cvv_code: '123',
+    amount: Amount.new(
+        value: 2.3,
+        currency: 'PLN'
+    ),
+    payment_instrument: PaymentInstrument.new(
+        number: '4242424242424242',
+        expiration_year: 2045,
+        expiration_month: 12
+    )
+)
+```
+
+It's really repetitive and it makes it hard to
+modify the values of certain attributes or omit them
+conditionally.
+
+This gem provides a better way:
+
+```rb
+transaction = Transaction.build do |t|
+    t.cvv_code = '123'
+    t.amount do |a|
+        a.value = 2.3
+        a.currency = 'PLN'
+    end
+    t.payment_instrument do |p|
+        p.number = '4242424242424242'
+        p.expiration_year = 2045
+        p.expiration_month = 12
+    end
+end
+```
+
+That's possible because the getters of attributes with
+non-primitive types have been overridden to accept blocks.
+When a block is given to such a getter, it instantiates an empty object
+of its type and yields it to the block.
+
+### Conditional building
+
+This DSL makes it extremely easy to build nested
+objects conditionally.
+
+```rb
+transaction = Transaction.build do |t|
+    t.cvv_code = '123'
+    t.amount do |a|
+        a.value = 2.3 if some_flag?
+        a.currency = 'PLN'
+    end
+    t.payment_instrument do |p|
+        p.number = '4242424242424242'
+        if some_condition?
+            p.expiration_year = 2045
+            p.expiration_month = 12
+        end
+    end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/Verseth/ruby-shale-builder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+::Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = ::FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+::RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/shale/builder/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Shale
+  module Builder
+    # @return [String]
+    VERSION = '0.1.0'
+  end
+end

data/lib/shale/builder.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'shale'
+
+require_relative 'builder/version'
+
+module Shale
+  # It's meant to be included in subclasses of `Shale::Mapper`
+  # to provide an easier way of building instances.
+  #
+  # Example:
+  #
+  #       require 'shale/builder'
+  #
+  #       class PaymentInstrument < Shale::Mapper
+  #         include Shale::Builder
+  #
+  #         attribute :number, Shale::Type::String
+  #         attribute :expiration_year, ::Shale::Type::Integer
+  #         attribute :expiration_month, ::Shale::Type::Integer
+  #       end
+  #
+  #       class Transaction < ::Shale::Mapper
+  #         include Shale::Builder
+  #
+  #         attribute :cvv_code, Shale::Type::String
+  #         attribute :payment_instrument, PaymentInstrument
+  #       end
+  #
+  #       transaction = Transaction.build do |t|
+  #           t.cvv_code = '123'
+  #           t.payment_instrument do |p|
+  #               p.number = '4242424242424242'
+  #               p.expiration_year = 2045
+  #               p.expiration_month = 12
+  #           end
+  #       end
+  #
+  module Builder
+    class << self
+      # Gets called after including this module.
+      #
+      # @param mod [Module]
+      def included(mod)
+        mod.extend ClassMethods
+        builder_methods_module = ::Module.new
+        mod.instance_variable_set :@builder_methods_module, builder_methods_module
+        mod.include builder_methods_module
+      end
+    end
+
+    # Class methods provided by `Shale::Builder`
+    module ClassMethods
+      # Contains overridden getter methods for attributes
+      # with complex types (so that they accept a block for building)
+      #
+      # @return [Module]
+      attr_reader :builder_methods_module
+
+      # @return [Class, nil]
+      attr_accessor :request_class
+
+      # @yieldparam [self]
+      # @return [self]
+      def build
+        body = new
+        yield(body)
+
+        body
+      end
+
+      # @param name [String, Symbol]
+      # @param type [Class]
+      # @return [void]
+      def attribute(name, type, *args, **kwargs, &block)
+        super
+        return unless type < ::Shale::Mapper
+
+        @builder_methods_module.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{name}                                   # def amount
+            return super unless block_given?            #   return super unless block_given?
+                                                        #
+            object = #{type}.new                        #   object = Amount.new
+            yield(object)                               #   yield(object)
+            self.#{name} = object                       #   self.amount = object
+          end                                           # end
+        RUBY
+      end
+
+    end
+
+  end
+end

data/sig/shale/builder.rbs

@@ -0,0 +1,6 @@
+module Shale
+  module Builder
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: shale-builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Drewniak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shale
+  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'
+description: An addon to the shale Ruby gem which adds a simple yet powerful builder
+  DSL.
+email:
+- matmg24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/shale/builder.rb
+- lib/shale/builder/version.rb
+- sig/shale/builder.rbs
+homepage: https://github.com/Verseth/ruby-shale-builder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Verseth/ruby-shale-builder
+  source_code_uri: https://github.com/Verseth/ruby-shale-builder
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: An addon to the shale Ruby gem which adds a simple yet powerful builder DSL.
+test_files: []