haku 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b807f104854f0cd9619b5a3a5be55a5e9744e7eaef85ace5f775772395d9957b
+  data.tar.gz: fb389738d56e37d6f397ee32316c7ad249ef95ad1d39f790c083742a0e6fad83
+SHA512:
+  metadata.gz: baa9206fa09e7aec2212a226fc66a0dd4a4fcb88ca437c95032c1e7f9fb244fda6e2fa9b7869d38c736a3c88970fa808bc12234f72d93d0d3ba741f3107a68e1
+  data.tar.gz: 3fbcf48768c7125fb1e60c1b1b022cef94b34e6cfc1236ada836d559d2e4595776a12a441f6af2fe0fc7cd948675b43681479edeb66836bf436b3ea12e7e7294

data/.editorconfig

@@ -0,0 +1,12 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/.pryrc

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Pry.config.prompt_name = "[haku]"

data/.rubocop.yml

@@ -0,0 +1,33 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+    - Prefixes
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - "**/bin/**/*"
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,105 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for
+everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity
+and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion,
+or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take
+appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for
+moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing
+the community in public spaces. Examples of representing our community include using an official e-mail address, posting
+via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible
+for enforcement at javier.aranda.varo@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem
+in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the
+community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation
+and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including
+unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding
+interactions in community spaces as well as external channels like social media. Violating these terms may lead to a
+temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified
+period of time. No public or private interaction with the people involved, including unsolicited interaction with those
+enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate
+behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "3.1.1"
+
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest", "~> 0.19"
+gem "rubocop-rake", "~> 0.6"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    haku (0.1.0)
+      activesupport (>= 6.0, < 8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.19.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  haku!
+  minitest (~> 5.0)
+  pry (~> 0.14)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-minitest (~> 0.19)
+  rubocop-rake (~> 0.6)
+
+RUBY VERSION
+   ruby 3.1.1p18
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Javier Aranda
+
+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,46 @@
+# Haku
+
+![CI](https://github.com/javierav/haku/workflows/CI/badge.svg)
+
+TODO: Write a better gem description.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'haku'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/javierav/haku. This project is intended to be
+a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[code of conduct](https://github.com/javierav/haku/blob/development/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Haku project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/javierav/haku/blob/development/CODE_OF_CONDUCT.md).
+
+## 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/haku/controller.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/hash/reverse_merge"
+
+module Haku
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :execution
+    end
+
+    def execute(action, params={})
+      @execution = action.call(params.reverse_merge(default_execute_params || {}))
+    end
+
+    def default_execute_params
+      { current_user: current_user } if respond_to?(:current_user)
+    end
+  end
+end

data/lib/haku/core.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/class/attribute"
+require_relative "result"
+
+module Haku
+  module Core
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :params
+
+      class_attribute :haku_success_callbacks, default: []
+      class_attribute :haku_failure_callbacks, default: []
+    end
+
+    module ClassMethods
+      def call(params={})
+        new(params).run
+      end
+
+      def on_success(*methods)
+        self.haku_success_callbacks += methods
+      end
+
+      def on_failure(*methods)
+        self.haku_failure_callbacks += methods
+      end
+    end
+
+    def initialize(params={})
+      @params = params
+
+      @params.each_key do |key|
+        define_singleton_method(key) { @params[key] } unless respond_to?(key)
+      end
+    end
+
+    def run
+      result = call
+
+      Result.new(_haku_status, _haku_response.merge(result: result)).tap do
+        _haku_run_callbacks
+      end
+    end
+
+    private
+
+    def success!(response={})
+      @_haku_status = :success
+      @_haku_response = _haku_normalize_response(response)
+      nil
+    end
+
+    def failure!(response={})
+      @_haku_status = :failure
+      @_haku_response = _haku_normalize_response(response)
+      nil
+    end
+
+    def _haku_normalize_response(response)
+      response.is_a?(Hash) ? response : { data: response }
+    end
+
+    def _haku_status
+      @_haku_status || :success
+    end
+
+    def _haku_response
+      @_haku_response || {}
+    end
+
+    def _haku_run_callbacks
+      (self.class.send("haku_#{_haku_status}_callbacks") || []).each { |cb| send(cb) }
+    end
+  end
+end

data/lib/haku/railtie.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require_relative "controller"
+
+module Haku
+  class Railtie < ::Rails::Railtie
+    initializer "haku.action_controller_base" do
+      if Haku.enable_in_action_controller_base
+        ActiveSupport.on_load(:action_controller_base) do
+          ActionController::Base.include Haku::Controller
+        end
+      end
+
+      if Haku.enable_in_action_controller_api
+        ActiveSupport.on_load(:action_controller_api) do
+          ActionController::API.include Haku::Controller
+        end
+      end
+    end
+  end
+end

data/lib/haku/resourceable.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Haku
+  module Resourceable
+    def create_resource(parent, attributes, ivar=nil, singleton: nil)
+      parent.send(singleton ? "create_#{singleton}" : "create", attributes).tap do |resource|
+        instance_variable_set("@#{ivar}", resource) if ivar.present?
+
+        if resource.persisted?
+          yield resource if block_given?
+          success! resource: resource
+        else
+          failure! resource: resource, errors: resource.errors
+        end
+      end
+    end
+
+    def update_resource(resource, attributes)
+      resource.tap do
+        if resource.update(attributes)
+          yield resource if block_given?
+          success! resource: resource
+        else
+          failure! resource: resource, errors: resource.errors
+        end
+      end
+    end
+
+    def destroy_resource(resource)
+      resource.tap do
+        if resource.destroy
+          yield resource if block_given?
+          success! resource: resource
+        else
+          failure! resource: resource, errors: resource.errors
+        end
+      end
+    end
+  end
+end

data/lib/haku/result.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "active_support/string_inquirer"
+
+module Haku
+  class Result
+    def initialize(status, response)
+      @status = ActiveSupport::StringInquirer.new(status.to_s)
+      @response = response
+
+      @response.each_key do |key|
+        define_singleton_method(key) { @response[key] }
+      end
+    end
+
+    def success?
+      @status.success?
+    end
+
+    def failure?
+      @status.failure?
+    end
+  end
+end

data/lib/haku/version.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Haku
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+
+  def self.version
+    VERSION::STRING
+  end
+
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+end

data/lib/haku.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/attribute_accessors"
+require_relative "haku/core"
+require_relative "haku/railtie" if defined?(Rails)
+require_relative "haku/resourceable"
+require_relative "haku/version"
+
+module Haku
+  mattr_accessor :enable_in_action_controller_base, default: true
+  mattr_accessor :enable_in_action_controller_api, default: true
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: haku
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Javier Aranda
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description:
+email:
+- javier.aranda.varo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".editorconfig"
+- ".envrc"
+- ".pryrc"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/haku.rb
+- lib/haku/controller.rb
+- lib/haku/core.rb
+- lib/haku/railtie.rb
+- lib/haku/resourceable.rb
+- lib/haku/result.rb
+- lib/haku/version.rb
+homepage: https://github.com/javierav/haku
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/javierav/haku
+  source_code_uri: https://github.com/javierav/haku/tree/v1.0.0
+  changelog_uri: https://github.com/javierav/haku/blob/v1.0.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A library for build simple service objects
+test_files: []