hammy 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc787edc7fd7d6ddbd692313209f890c4de8c426d6f382ab456918927902c463
+  data.tar.gz: e5cbf31778c2347ff1d95f7f097c96a59e29849bd3292fc4084f0dd139847c1c
+SHA512:
+  metadata.gz: 6d494343ae80d5a386e99ee1a8687bbdc39b7310103f7986ff7632d67c16a08e14138841c36667573d62d05d1b66f5d3ab6675757ce16e1763014e8a62fe76cc
+  data.tar.gz: f5ef424dd216fc2be77094a02b0468c7af710546159ce40c3adf22eb27895a6ffd68cbace82620baa4c5458cf7de8d1dbbe39162dad19425a08353fcb5cf341d

data/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Check and Release New Version
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 2
+
+    - name: Setup Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Release Gem
+      id: release-gem
+      uses: salsify/action-release-gem@76815459482984159ec020def58da8aed594e618
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+  - 'vendor/**/*'
+  - 'gemfiles/vendor/**/*'
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: beginning_only
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+

data/.ruby-gemset

@@ -0,0 +1 @@
+hammy

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.3

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
+
+## 0.2.0 - 2021-02-05
+### Added
+- Add release automation
+
+## 0.1.0 - 2019-02-23
+### Added
+- Initial version
+- Add `ServiceObject`

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in hammy.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec, cmd: "bundle exec rspec --format progress", notification: true do
+  watch("spec/spec_helper.rb") { "spec" }
+  watch(%r{^spec\/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Erik Kessler
+
+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,60 @@
+# Hammy
+
+Various Ruby stuff.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hammy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hammy
+
+## Usage
+
+### ServiceObject
+
+Easily build "thing doer" classes by subclassing `Hammy::ServiceObject#build`.
+Available argument styles: `keyword` and `positional`.
+
+```ruby
+class ThingDoer < Hammy::ServiceObject.keyword(:one, :two)
+
+  def do_the_thing
+    puts "Doing the thing with #{one} and #{two}..."
+  end
+end
+
+ThingDoer.do_the_thing(one: :a, two: :b)
+```
+
+## 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/erikkessler1/hammy.## 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,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pry"
+
+require "hammy"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -v
+
+bundle update

data/hammy.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hammy/version"
+
+Gem::Specification.new do |spec|
+  raise "RubyGems 2.0 or newer is required!" unless spec.respond_to?(:metadata)
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.name = "hammy"
+  spec.version = Hammy::VERSION
+  spec.authors = ["Erik Kessler"]
+  spec.email = ["erik.kessler1@gmail.com"]
+
+  spec.summary = "Some Ruby utils and fun."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/erikkessler1/hammy"
+
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rubocop"
+end

data/lib/hammy.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "./hammy/service_object"
+require_relative "./hammy/version"
+
+module Hammy
+end

data/lib/hammy/abstract_service_object.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Hammy
+  class AbstractServiceObject
+
+    def self.build(*args, **kargs)
+      new(*args, **kargs).klass
+    end
+
+    def initialize(*args, **kargs)
+      @args = args
+      @kargs = kargs
+    end
+
+    def klass
+      this = self
+
+      Class.new do
+        eigenclass = class << self; self; end
+        eigenclass.class_eval do
+          define_method(:method_missing) do |method, *args, **kargs, &block|
+            return super(method, *args, **kargs, &block) unless this.valid_action?(self, method)
+
+            new(args, kargs).send(method)
+          end
+
+          define_method(:respond_to_missing?) do |method, include_private = false|
+            this.valid_action?(self, method) || super(method, include_private)
+          end
+        end
+
+        define_method(:initialize) do |args, kargs|
+          this.validate_args!(args, kargs)
+
+          this.initial_instance_variables(args, kargs).each do |var, value|
+            instance_variable_set(var, value)
+          end
+        end
+
+        this.public_getters.each do |getter|
+          attr_reader(getter)
+        end
+
+        protected
+
+        this.protected_getters.each do |getter|
+          attr_reader(getter)
+        end
+
+        private
+
+        this.private_getters.each do |getter|
+          attr_reader(getter)
+        end
+      end
+    end
+
+    def valid_action?(klass, method)
+      klass.instance_methods(false).include?(method)
+    end
+
+    def validate_args!(args, kargs); end
+
+    def initial_instance_variables(_args, _kargs)
+      {}
+    end
+
+    def public_getters
+      []
+    end
+
+    def protected_getters
+      []
+    end
+
+    def private_getters
+      []
+    end
+  end
+end

data/lib/hammy/keyword_service_object.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "./abstract_service_object"
+
+module Hammy
+  class KeywordServiceObject < Hammy::AbstractServiceObject
+
+    def validate_args!(args, kargs)
+      raise ArgumentError.new("wrong number of arguments (given #{args.size}, expected 0; required keywords: #{@args.join(', ')})") unless args.empty?
+
+      missing = @args - kargs.keys
+      raise ArgumentError.new("missing keywords: #{missing.join(', ')}") unless missing.empty?
+
+      unknown = kargs.keys - @args
+      raise ArgumentError.new("unknown keywords: #{unknown.join(', ')}") unless unknown.empty?
+    end
+
+    def initial_instance_variables(_args, kargs)
+      @args.map do |a|
+        ["@#{a}", kargs[a]]
+      end
+    end
+
+    def private_getters
+      @args
+    end
+  end
+end

data/lib/hammy/positional_service_object.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "./abstract_service_object"
+
+module Hammy
+  class PositionalServiceObject < Hammy::AbstractServiceObject
+
+    def validate_args!(pargs, kargs)
+      args = all_args(pargs, kargs)
+      raise ArgumentError.new("wrong number of arguments (given #{args.size}, expected #{@args.size})") if args.size != @args.size
+    end
+
+    def initial_instance_variables(pargs, kargs)
+      args = all_args(pargs, kargs)
+      @args.zip(args).map { |a, b| ["@#{a}", b] }
+    end
+
+    def private_getters
+      @args
+    end
+
+    private
+
+    def all_args(pargs, kargs)
+      return pargs unless kargs.any?
+
+      pargs + [kargs]
+    end
+  end
+end

data/lib/hammy/service_object.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "./keyword_service_object"
+require_relative "./positional_service_object"
+
+module Hammy
+  module ServiceObject
+    extend self
+
+    def positional(*args, **kargs)
+      Hammy::PositionalServiceObject.build(*args, **kargs)
+    end
+
+    def keyword(*args, **kargs)
+      Hammy::KeywordServiceObject.build(*args, **kargs)
+    end
+  end
+end

data/lib/hammy/version.rb

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

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: hammy
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Erik Kessler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Some Ruby utils and fun.
+email:
+- erik.kessler1@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hammy.gemspec
+- lib/hammy.rb
+- lib/hammy/abstract_service_object.rb
+- lib/hammy/keyword_service_object.rb
+- lib/hammy/positional_service_object.rb
+- lib/hammy/service_object.rb
+- lib/hammy/version.rb
+homepage: https://github.com/erikkessler1/hammy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Some Ruby utils and fun.
+test_files: []