not_monads 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e9974bab26e9af1e3ec8fad57c6b72b706bcbc1933fed1ec606050103252bb3
+  data.tar.gz: 560ddae392216cc701cc94281471084c22dd9042f44e561b80cfe7a76fb98f36
+SHA512:
+  metadata.gz: bf6b4273f3e41abd484a1022fb1475431b73dc3ee60a0c7df5ecca9939e55bb8e40bcae2b05f8989cb2315200fd5b426ebd7f9d51b907c1961121f00ef4dc5b4
+  data.tar.gz: e658304d770247652411c4855f670d367119916dd132d720ff57a9a374a67c4adac16021adcbf6c8c38b0c65e24930366d56c715af04fc4f307488a21d4eefac

data/.devcontainer/devcontainer.json

@@ -0,0 +1,52 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
+{
+	"name": "not_monads devcontainer",
+
+	// Update the 'dockerComposeFile' list if you have more compose files or use different names.
+	// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
+	"dockerComposeFile": [
+		"../docker-compose.yml",
+		"docker-compose.yml"
+	],
+
+	// The 'service' property is the name of the service for the container that VS Code should
+	// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
+	"service": "not_monads",
+
+	// The optional 'workspaceFolder' property is the path VS Code should open by default when
+	// connected. This is typically a file mount in .devcontainer/docker-compose.yml
+	// "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}"
+	"workspaceFolder": "/app",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-azuretools.vscode-docker",
+				"EditorConfig.EditorConfig",
+				"eamodio.gitlens",
+				"Shopify.ruby-extensions-pack"
+			]
+		}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Uncomment the next line if you want start specific services in your Docker Compose config.
+	// "runServices": [],
+
+	// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+	// "shutdownAction": "none",
+
+	// Uncomment the next line to run commands after the container is created.
+	// "postCreateCommand": "cat /etc/os-release",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "devcontainer"
+}

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,26 @@
+version: '3.4'
+services:
+  # Update this to the name of the service you want to work with in your docker-compose.yml file
+  not_monads:
+    # Uncomment if you want to override the service's Dockerfile to one in the .devcontainer
+    # folder. Note that the path of the Dockerfile and context is relative to the *primary*
+    # docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
+    # array). The sample below assumes your primary file is in the root of your project.
+    #
+    # build:
+    #   context: .
+    #   dockerfile: .devcontainer/Dockerfile
+
+    # volumes:
+    #   # Update this to wherever you want VS Code to mount the folder of your project
+    #   - ..:/workspaces:cached
+
+    # Uncomment the next four lines if you will use a ptrace-based debugger like C++, Go, and Rust.
+    # cap_add:
+    #   - SYS_PTRACE
+    # security_opt:
+    #   - seccomp:unconfined
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: /bin/sh -c "while sleep 1000; do :; done"
+

data/.dockerignore

@@ -0,0 +1,25 @@
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/bin
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-thread_safety
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 4
+
+Style/CaseEquality:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-12-30
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,18 @@
+FROM ruby:3.3-alpine
+
+LABEL Name=not_monads Version=0.1.0
+
+RUN apk add --update git
+
+# throw errors if Gemfile has been modified since Gemfile.lock
+# RUN bundle config --global frozen 1
+
+WORKDIR /app
+
+COPY Gemfile Gemfile.lock not_monads.gemspec ./
+COPY lib/not_monads/version.rb lib/not_monads/version.rb
+RUN bundle install
+
+COPY . /app
+
+# CMD ["ruby", "serviceobjects.rb"]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 kolas
+
+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,57 @@
+# NotMonads
+
+Simple copy of [dry-monads](https://github.com/dry-rb/dry-monads) do monads, it implements only mixin for your service object and Success/Failure result object.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add not_monads
+
+or add to Gemfile
+
+    gem 'not_monads'
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install not_monads
+
+## Usage
+
+Add module to your class with prepend:
+
+```
+class CreateUser
+    prepend NotMonads::Do[:call]
+
+    def call(params)
+      do_something validate(params)
+      user = do_something save(params)
+      Success(user)
+    end
+
+    private
+
+    def validate(params)
+      Success() || Failure(:error)
+    end
+
+    def save(params)
+      Success(user) || Failure(errors)
+    end
+  end
+end
+```
+
+Prepend with a module call with array of method names in square brackets. (`prepend NotMonads::Do[:call, :step1, :step3]`) Use method `do_something` to verify result, just like dry-monads with `yield` (`do_something` is a temporary method name, idk how to name it better yet)
+
+
+## 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).
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3.4'
+
+services:
+  not_monads:
+    image: not_monads
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    container_name: not_monads
+    volumes:
+      - .:/app:cached
+      - bundle:/usr/local/bundle
+
+volumes:
+  bundle:

data/lib/not_monads/do.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'result'
+
+module NotMonads
+  module Do
+    module MixinInstance
+      # rubocop:disable Naming/MethodName
+      def Success(value = nil)
+        NotMonads::Result::Success.new(value)
+      end
+
+      def Failure(value = nil)
+        NotMonads::Result::Failure.new(value)
+      end
+      # rubocop:enable Naming/MethodName
+
+      def do_something(result)
+        return result.success if result.success?
+
+        halt(result)
+      end
+
+      def halt(result)
+        raise Halt, result
+      end
+    end
+
+    class Halt < StandardError
+      attr_reader :result
+
+      def initialize(result)
+        super()
+        @result = result
+      end
+    end
+
+    class << self
+      def [](*methods)
+        Module.new do
+          methods.each do |method|
+            define_method(method) do |*args, **kwargs, &block|
+              super(*args, **kwargs, &block)
+            rescue Halt => e
+              e.result
+            end
+          end
+
+          include MixinInstance
+        end
+      end
+    end
+  end
+end

data/lib/not_monads/result.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module NotMonads
+  class Result
+    attr_reader :success, :failure
+
+    class Success < Result
+      def initialize(value)
+        super()
+        @success = value
+      end
+
+      def failure?
+        false
+      end
+
+      def success?
+        true
+      end
+
+      def to_s
+        "Success(#{success.inspect})"
+      end
+      alias inspect to_s
+
+      def value!
+        success
+      end
+
+      def value_or(_val = nil)
+        success
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && value! == other.value!
+      end
+
+      def ===(other)
+        other.instance_of?(self.class) && value! === other.value!
+      end
+    end
+
+    class Failure < Result
+      def initialize(value)
+        super()
+        @failure = value
+      end
+
+      def failure?
+        true
+      end
+
+      def success?
+        false
+      end
+
+      def to_s
+        "Failure(#{failure.inspect})"
+      end
+      alias inspect to_s
+
+      def value!
+        raise Error, "value! was called on #{self}"
+      end
+
+      def value_or(val = nil)
+        if block_given?
+          yield
+        else
+          val
+        end
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && failure == other.failure
+      end
+
+      def ===(other)
+        other.instance_of?(self.class) && failure === other.failure
+      end
+    end
+  end
+end

data/lib/not_monads/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NotMonads
+  VERSION = '0.1.0'
+end

data/lib/not_monads.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'not_monads/version'
+require_relative 'not_monads/do'
+
+module NotMonads
+  class Error < StandardError; end
+end

data/sig/not_monads.rbs

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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: not_monads
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kolas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-10 00:00:00.000000000 Z
+dependencies: []
+description: Simple copy of [dry-monads](https://github.com/dry-rb/dry-monads) do
+  monads, it implements only mixin for your service object and Success/Failure result
+  object.
+email:
+- kolas.krytoi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/docker-compose.yml"
+- ".dockerignore"
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Dockerfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docker-compose.yml
+- lib/not_monads.rb
+- lib/not_monads/do.rb
+- lib/not_monads/result.rb
+- lib/not_monads/version.rb
+- sig/not_monads.rbs
+homepage: https://github.com/kolasss/not_monads
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kolasss/not_monads
+  source_code_uri: https://github.com/kolasss/not_monads
+  changelog_uri: https://github.com/kolasss/not_monads/blob/master/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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Simple service objects
+test_files: []