muina 0.2.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 406f36585e9a83b4436c4d055ad66e3c5387f4a9102cc5e441999379625fab21
-  data.tar.gz: 11feb70f115ddfa6b68357c70e3bf38727dc1fac02d18540e1f2ebd56ff46024
+  metadata.gz: 868d82b70df649f4904a718c34d487f5c05da90a0e9d28620765c080cb970020
+  data.tar.gz: 322edb475ebf673ae7d54b8bae3e6c44a0a0be9b7a2bb80df5d27f474b35d90c
 SHA512:
-  metadata.gz: 52000f4ca1c38ddbf38ca826ed94d295d6119d00c40851fdd311ae6d3c1bb6fee42d5dd58f3e1a8b937b4eb0f1bf373949ded1d7ade0f88ea2c005ee38fc4b04
-  data.tar.gz: ed926845c343654537e5bb2078b1a28911fbfad27af85b7df2e4ac11c5539ecc8234357cfb234ec1e21c832a2dba44bc99373535138071e8f2bd7f71a94e3566
+  metadata.gz: 996ea7ae5699568af2096e486edf7df2eaf72c4ca7b2dfd1d40d3c54483fa1c2d97227f1c53947ec674a698a8abd5368e5fb854fc5a998c2ec0cbe231094bec6
+  data.tar.gz: a93c3d768491556b845fbeb7d00e7424e5b9966b1ed5b940abc627f4b9a873b7184615c4e5f55f55a073fe0e1ece527610e48055a0dac8a5e84156438c96bcae

data/LICENSE

@@ -0,0 +1,25 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>
+

data/README.md

@@ -1,36 +1 @@
 # Muina
-
-[![Gem Version](https://badge.fury.io/rb/muina.svg)](https://badge.fury.io/rb/muina)
-
-Typesafe base objects to make your code safer and cleaner.
-
-## Installation
-
-```ruby
-gem 'muina'
-```
-
-## Usage
-
-* Muina::Action: self extracting, step based, result returning features
-* Muina::Params: self extracting typed params
-* Muina::PrivateCreation: mixin to make `.new` and `.allocate` private
-* Muina::Result: type safe result monad
-* Muina::Service: service object with typesafe constants and attributes
-* Muina::Value: typesafe immutable struct-like objects
-* `muina` CLI: to copy bundled rbi file
-
-## 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 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/vaporyhumo/muina.
-This project is intended to be a safe, welcoming space for collaboration.

data/lib/muina/maybe/none.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Muina
+  class Maybe
+    class None < self
+      private_class_method(:new)
+      def initialize
+        freeze
+      end
+
+      def some?
+        false
+      end
+
+      def none?
+        true
+      end
+
+      def value!
+        raise
+      end
+
+      def value_or(default)
+        default
+      end
+
+      def value_or_yield
+        yield
+      end
+
+      def value_or_nil
+        nil
+      end
+
+      def and_then
+        self
+      end
+
+      def or_else
+        yield
+        self
+      end
+
+      def map
+        self
+      end
+      
+      def map_none
+        Maybe.return yield
+      end
+
+      def bind
+        self
+      end
+
+      def bind_none
+        yield
+      end
+    end
+  end
+end

data/lib/muina/maybe/some.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Muina
+  class Maybe
+    class Some < self
+      def initialize(value)
+        @value = value
+        freeze
+      end
+      private_class_method(:new)
+
+      def some?
+        true
+      end
+
+      def none?
+        false
+      end
+
+      def value!
+        @value
+      end
+
+      def value_or(default)
+        @value
+      end
+
+      def value_or_yield
+        @value
+      end
+
+      def value_or_nil
+        @value
+      end
+
+      def and_then
+        yield(@value)
+        self
+      end
+
+      def or_else
+        self
+      end
+
+      def map
+        Maybe.return yield(@value)
+      end
+      
+      def map_none
+        self
+      end
+
+      def bind
+        yield(@value)
+      end
+
+      def bind_none
+        self
+      end
+    end
+  end
+end

data/lib/muina/maybe.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Muina
+  class Maybe
+    def self.return(value)
+      Some.__send__(:new, value)
+    end
+
+    def self.none
+      None.__send__(:new)
+    end
+  end
+end

data/lib/muina/result/failure.rb

@@ -1,30 +1,19 @@
-# typed: strict
 # frozen_string_literal: true
 
 module Muina
-  class Result < Value
-    # Right(wrong) side of the Result Monad
+  class Result
     class Failure < self
-      class ValueCalledOnFailureError < Error; end
-
-      const :error, T.untyped
-      private :error
+      def initialize(error)
+        @error = error
+        freeze
+      end
 
       def value!
-        raise ValueCalledOnFailureError
+        raise
       end
 
       def error!
-        error
-      end
-
-      def and_then(&_blk)
-        self
-      end
-
-      def or_else(&blk)
-        blk[error] if blk
-        self
+        @error
       end
     end
   end

data/lib/muina/result/success.rb

@@ -1,30 +1,19 @@
-# typed: strict
 # frozen_string_literal: true
 
 module Muina
-  class Result < Value
-    # Left(correct) side of the Result Monad
+  class Result
     class Success < self
-      class ErrorCalledOnSuccessError < Error; end
-
-      const :value, T.untyped
-      private :value
+      def initialize(value)
+        @value = value
+        freeze
+      end
 
       def value!
-        value
+        @value
       end
 
       def error!
-        raise ErrorCalledOnSuccessError
-      end
-
-      def and_then(&blk)
-        blk[value] if blk
-        self
-      end
-
-      def or_else(&_blk)
-        self
+        raise
       end
     end
   end

data/lib/muina/result.rb

@@ -1,17 +1,15 @@
-# typed: strict
 # frozen_string_literal: true
 
 module Muina
-  # Result Monad
-  class Result < Value
-    include PrivateCreation
+  class Result
+    private_class_method :new
 
-    def self.Null # rubocop:disable Naming/MethodName
-      Null.__send__(:new)
+    def self.success(value)
+      Success.__send__(:new, value)
     end
 
-    def self.[](success_klass, error_klass)
-      Factory.new(success_klass: success_klass, error_klass: error_klass)
+    def self.failure(error)
+      Failure.__send__(:new, error)
     end
   end
 end

data/lib/muina/version.rb

@@ -1,7 +1,6 @@
-# typed: strict
 # frozen_string_literal: true
 
 module Muina
-  VERSION = '0.2.8'
+  VERSION = '0.4.0'
   public_constant :VERSION
 end

data/lib/muina.rb

@@ -1,42 +1,10 @@
-# typed: strict
 # frozen_string_literal: true
 
-# Load dependencies
-require 'action_controller'
-require 'action_controller/metal/exceptions'
-require 'sorbet-runtime'
-require 'sorbet-rails/typed_params'
-require 'sorbet-struct-comparable'
-
-# Require Module monkeypatch
-require 'muina/module'
-
-# Setup zeitwork loader
 require 'zeitwerk'
 loader = Zeitwerk::Loader.for_gem
-module_ext = "#{__dir__}/muina/module.rb"
-loader.ignore(module_ext)
 loader.setup
 
-# Top level module
 module Muina
-  class Error < StandardError; end
-
-  def self.Success(value) # rubocop:disable Naming/MethodName
-    Result::Success.__send__(:new, value: value)
-  end
-
-  def self.Failure(error) # rubocop:disable Naming/MethodName
-    Result::Failure.__send__(:new, error: error)
-  end
-
-  def self.Result(&blk) # rubocop:disable Naming/MethodName
-    Success(blk[])
-  rescue StandardError => e
-    Failure(e)
-  end
 end
-M = Muina
 
-# Eager load all code
 loader.eager_load

metadata

@@ -1,271 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: muina
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.4.0
 platform: ruby
 authors:
 - vaporyhumo
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  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: sorbet-rails
-  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: sorbet-runtime
-  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: sorbet-struct-comparable
-  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: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Useful parent classes for the Rails missing parts
+        version: '2'
+description: Monads and other stuff to help you write safer Ruby code
 email:
 - roanvilina@gmail.com
-executables:
-- muina
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".mutant.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".simplecov"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- Guardfile
+- LICENSE
 - README.md
-- Rakefile
-- SECURITY.md
-- bin/bundle
-- bin/console
-- bin/flay
-- bin/flog
-- bin/guard
-- bin/irb
-- bin/lefthook
-- bin/mutant
-- bin/parlour
-- bin/rake
-- bin/rspec
-- bin/rubocop
-- bin/setup
-- bin/srb
-- bin/srb-rbi
-- bin/tapioca
-- exe/muina
-- lefthook.yml
 - lib/muina.rb
-- lib/muina/action.rb
-- lib/muina/action/params_factory.rb
-- lib/muina/action/step.rb
-- lib/muina/action/step/command.rb
-- lib/muina/action/step/failure.rb
-- lib/muina/action/step/query.rb
-- lib/muina/action/step/result.rb
-- lib/muina/any.rb
-- lib/muina/classes.rb
-- lib/muina/deprecator.rb
-- lib/muina/entity.rb
-- lib/muina/module.rb
-- lib/muina/parameters.rb
-- lib/muina/params.rb
-- lib/muina/private_creation.rb
+- lib/muina/maybe.rb
+- lib/muina/maybe/none.rb
+- lib/muina/maybe/some.rb
 - lib/muina/result.rb
-- lib/muina/result/factory.rb
 - lib/muina/result/failure.rb
-- lib/muina/result/null.rb
 - lib/muina/result/success.rb
-- lib/muina/service.rb
-- lib/muina/symbol_hash.rb
-- lib/muina/unit.rb
-- lib/muina/untyped_array.rb
-- lib/muina/untyped_hash.rb
-- lib/muina/value.rb
 - lib/muina/version.rb
-- muina.gemspec
-- rbi/muina.rbi
-- sorbet/config
-- sorbet/rbi/gems/actionpack@6.1.4.rbi
-- sorbet/rbi/gems/actionview@6.1.4.rbi
-- sorbet/rbi/gems/activesupport@6.1.4.rbi
-- sorbet/rbi/gems/ast@2.4.2.rbi
-- sorbet/rbi/gems/awesome_print@1.9.2.rbi
-- sorbet/rbi/gems/builder@3.2.4.rbi
-- sorbet/rbi/gems/byebug@11.1.3.rbi
-- sorbet/rbi/gems/coderay@1.1.3.rbi
-- sorbet/rbi/gems/colorize@0.8.1.rbi
-- sorbet/rbi/gems/commander@4.6.0.rbi
-- sorbet/rbi/gems/concurrent-ruby@1.1.9.rbi
-- sorbet/rbi/gems/crass@1.0.6.rbi
-- sorbet/rbi/gems/diff-lcs@1.4.4.rbi
-- sorbet/rbi/gems/docile@1.4.0.rbi
-- sorbet/rbi/gems/erubi@1.10.0.rbi
-- sorbet/rbi/gems/erubis@2.7.0.rbi
-- sorbet/rbi/gems/faker@2.18.0.rbi
-- sorbet/rbi/gems/ffi@1.15.3.rbi
-- sorbet/rbi/gems/flay@2.12.1.rbi
-- sorbet/rbi/gems/flog@4.6.4.rbi
-- sorbet/rbi/gems/formatador@0.3.0.rbi
-- sorbet/rbi/gems/guard-compat@1.2.1.rbi
-- sorbet/rbi/gems/guard-rspec@4.7.3.rbi
-- sorbet/rbi/gems/guard-rubocop@1.4.0.rbi
-- sorbet/rbi/gems/guard-shell@0.7.2.rbi
-- sorbet/rbi/gems/guard@2.18.0.rbi
-- sorbet/rbi/gems/highline@2.0.3.rbi
-- sorbet/rbi/gems/i18n@1.8.10.rbi
-- sorbet/rbi/gems/io-console@0.5.9.rbi
-- sorbet/rbi/gems/irb@1.3.6.rbi
-- sorbet/rbi/gems/lefthook@0.7.6.rbi
-- sorbet/rbi/gems/listen@3.6.0.rbi
-- sorbet/rbi/gems/loofah@2.10.0.rbi
-- sorbet/rbi/gems/lumberjack@1.2.8.rbi
-- sorbet/rbi/gems/method_source@1.0.0.rbi
-- sorbet/rbi/gems/minitest@5.14.4.rbi
-- sorbet/rbi/gems/mutant-license@0.1.1.1.4043027289354708743625974235631451632228.0.rbi
-- sorbet/rbi/gems/mutant-rspec@0.10.32.rbi
-- sorbet/rbi/gems/mutant@0.10.32.rbi
-- sorbet/rbi/gems/nenv@0.3.0.rbi
-- sorbet/rbi/gems/nokogiri@1.11.7.rbi
-- sorbet/rbi/gems/notiffany@0.1.3.rbi
-- sorbet/rbi/gems/parallel@1.20.1.rbi
-- sorbet/rbi/gems/parlour@6.0.1.rbi
-- sorbet/rbi/gems/parser@3.0.2.0.rbi
-- sorbet/rbi/gems/path_expander@1.1.0.rbi
-- sorbet/rbi/gems/polyfill@1.9.0.rbi
-- sorbet/rbi/gems/pry@0.14.1.rbi
-- sorbet/rbi/gems/racc@1.5.2.rbi
-- sorbet/rbi/gems/rack-test@1.1.0.rbi
-- sorbet/rbi/gems/rack@2.2.3.rbi
-- sorbet/rbi/gems/rails-dom-testing@2.0.3.rbi
-- sorbet/rbi/gems/rails-html-sanitizer@1.3.0.rbi
-- sorbet/rbi/gems/rainbow@3.0.0.rbi
-- sorbet/rbi/gems/rake@13.0.6.rbi
-- sorbet/rbi/gems/rb-fsevent@0.11.0.rbi
-- sorbet/rbi/gems/rb-inotify@0.10.1.rbi
-- sorbet/rbi/gems/regexp_parser@2.1.1.rbi
-- sorbet/rbi/gems/reline@0.2.6.rbi
-- sorbet/rbi/gems/rexml@3.2.5.rbi
-- sorbet/rbi/gems/rspec-core@3.10.1.rbi
-- sorbet/rbi/gems/rspec-expectations@3.10.1.rbi
-- sorbet/rbi/gems/rspec-mocks@3.10.2.rbi
-- sorbet/rbi/gems/rspec-support@3.10.2.rbi
-- sorbet/rbi/gems/rspec@3.10.0.rbi
-- sorbet/rbi/gems/rubocop-ast@1.8.0.rbi
-- sorbet/rbi/gems/rubocop-performance@1.11.4.rbi
-- sorbet/rbi/gems/rubocop-rake@0.6.0.rbi
-- sorbet/rbi/gems/rubocop-rspec@2.4.0.rbi
-- sorbet/rbi/gems/rubocop-sorbet@0.6.2.rbi
-- sorbet/rbi/gems/rubocop@1.18.4.rbi
-- sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi
-- sorbet/rbi/gems/ruby_parser@3.16.0.rbi
-- sorbet/rbi/gems/safe_type@1.1.1.rbi
-- sorbet/rbi/gems/sexp_processor@4.15.3.rbi
-- sorbet/rbi/gems/shellany@0.0.1.rbi
-- sorbet/rbi/gems/simplecov-html@0.12.3.rbi
-- sorbet/rbi/gems/simplecov@0.21.2.rbi
-- sorbet/rbi/gems/simplecov_json_formatter@0.1.3.rbi
-- sorbet/rbi/gems/sorbet-coerce@0.5.0.rbi
-- sorbet/rbi/gems/sorbet-rails@0.7.4.rbi
-- sorbet/rbi/gems/sorbet-struct-comparable@1.1.0.rbi
-- sorbet/rbi/gems/spoom@1.1.1.rbi
-- sorbet/rbi/gems/tapioca@0.4.23.rbi
-- sorbet/rbi/gems/thor@1.1.0.rbi
-- sorbet/rbi/gems/tzinfo@2.0.4.rbi
-- sorbet/rbi/gems/unicode-display_width@2.0.0.rbi
-- sorbet/rbi/gems/unparser@0.6.0.rbi
-- sorbet/rbi/gems/zeitwerk@2.4.2.rbi
-- sorbet/rbi/todo.rbi
-- sorbet/rbi/typed_params.rbi
-- sorbet/tapioca/require.rb
 homepage: https://github.com/vaporyhumo/muina
-licenses: []
+licenses:
+- Unlicense
 metadata:
   homepage_uri: https://github.com/vaporyhumo/muina
-  source_code_uri: https://github.com/vaporyhumo/muina
-  changelog_uri: https://github.com/vaporyhumo/muina
-post_install_message: 
+  changelog_uri: https://github.com/vaporyhumo/muina/blob/main/CHANGELOG.md
+  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.6.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
-signing_key: 
+rubygems_version: 3.5.7
+signing_key:
 specification_version: 4
-summary: Rails and Sorbet compatible framework
+summary: Write safer Ruby code.
 test_files: []

data/.github/workflows/main.yml

@@ -1,16 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.6.6
-        bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake

data/.gitignore

@@ -1,5 +0,0 @@
-/coverage/
-/pkg/
-
-.rspec_status
-.byebug_history