resultify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f560a8f5e7f9d7cd6bc581cab5ead9ba0a721cb88ad1f01d5e1feb6049dfcc1
+  data.tar.gz: bf8b2e498bfb21d0497d44ab0110b4f4e423891aa26e5b757637244ba07105c2
+SHA512:
+  metadata.gz: 2924bb9eb581687a44487dedb138c471e3a35b6fb439adc8b9f61d874de5a95c841ef490598a2ef114f2b14c4a7c342d394573d4aa260bd7564d32c2c73f63da
+  data.tar.gz: dde77d9326f75af0ee7de31355eff94f9c95016af1ad70897a6090a625abb9794f29fdb23b17bf3291365c2ea007b84eb1e74b225aa8dd076b050cd2e1a7bbdd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at akshayt@m3india.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in resultify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    resultify (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (10.5.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  resultify!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Akshay Takkar
+
+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,74 @@
+# Resultify
+
+Inspired by Result and Option objects in Rust and Maybe Typeclass in Haskell. This gem adds these features to Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resultify'
+```
+## Usage
+
+```ruby
+class User
+  attr_accessor :first_name, :last_name
+  include Resultify
+  resultify :get_full_name
+
+  def initialize(fname, lname)
+    @first_name = fname
+    @last_name = lname
+  end
+
+  def get_full_name
+    @first_name + @last_name
+  end
+end
+
+u = User.new("John", nil)
+result = u.get_full_name
+result.error_handler = proc { |err| puts "could not get full name from user" }
+result.value_handler = proc { |v| puts "Hello #{v}" }
+```
+Resultify forces you to define the error_handler function before trying to access the value wrapped inside the Result object.
+If you define the value_handler without defining error_handler, you'll get an error.
+If `get_full_name` results in an error, the exception will be caught and the proc assigned to `result.error_handler` will be called otherwise `result.value_handler`.
+
+Similarly for handling blank values you can call the `optionify` method.
+
+```ruby
+class User
+  attr_accessor :first_name, :last_name
+  include Resultify
+  optionify :get_full_name
+
+  def initialize(fname, lname)
+    @first_name = fname
+    @last_name = lname
+  end
+
+  def get_full_name
+    first_name + last_name
+  end
+end
+
+u = User.new("", "")
+result = u.get_full_name
+result.blank_handler = proc { |err| puts "could not get full name from user" }
+result.value_handler = proc { |v| puts "Hello #{v}" }
+```
+If `u.get_full_name` return a blank value i.e `[], nil, ''` then the proc assigned to `result.blank_handler` will be called otherwise `result.value_handler`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/blackblood/resultify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Resultify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/blackblood/resultify/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resultify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/resultify/version.rb

@@ -0,0 +1,3 @@
+module Resultify
+  VERSION = "0.1.0"
+end

data/lib/resultify.rb

@@ -0,0 +1,121 @@
+# require "resultify/version"
+
+module Resultify
+  class Result
+    private
+    attr_accessor :value, :err
+
+    public
+    attr_reader :error_handler
+    attr_reader :value_handler
+
+    def initialize(ret_val, err)
+      @value = ret_val
+      @err = err
+    end
+
+    def error_handler=(f)
+      @error_handler = f
+      if @err != nil
+        f.call(@err)
+      end
+    end
+
+    def value_handler=(f)
+      raise "Define error_handler = proc { |err| } before calling value_handler" if !@error_handler.is_a?(Proc)
+      @result_handler = f
+      if @err == nil
+        f.call(@value)
+      end
+    end
+  end
+
+  class Option
+    private
+    attr_accessor :value
+
+    public
+    attr_reader :blank_handler
+    attr_reader :value_handler
+
+    def initialize(ret_val)
+      @value = ret_val
+    end
+
+    def blank_handler=(f)
+      @blank_handler = f
+      if @value == nil || @value == ""
+        f.call
+      end
+    end
+
+    def value_handler=(f)
+      raise "Define blank_handler = proc { } before calling value_handler" if !@blank_handler.is_a?(Proc)
+      if @value != nil && @value != ""
+        f.call(@value)
+      end
+    end
+  end
+
+  module ClassMethods
+    def overwrite_method_for_result(name)
+      @@overwriting_method = true
+      alias_method "old_#{name}".to_sym, name.to_sym
+      define_method name do |*args, &block|
+        begin
+          old_method = self.class.instance_method("old_#{name}")
+          ret_val = old_method.bind(self).call(*args, &block)
+          return Result.new(ret_val, nil)
+        rescue Exception => e
+          return Result.new(nil, e)
+        end
+      end
+      @@overwriting_method = false
+    end
+
+    def overwrite_method_for_option(name)
+      @@overwriting_method = true
+      alias_method "old_#{name}".to_sym, name.to_sym
+      define_method name do |*args, &block|
+        old_method = self.class.instance_method("old_#{name}")
+        ret_val = old_method.bind(self).call(*args, &block)
+        if ret_val == nil || ret_val == ""
+          return Option.new(ret_val)
+        else
+          return Option.new(nil)
+        end
+      end
+      @@overwriting_method = false
+    end
+
+    def resultify(*method_names)
+      @@resultify_method_names = method_names
+      self.instance_methods(false).each do |mname|
+        self.overwrite_method_for_result(mname) if @@resultify_method_names.include?(mname)
+      end
+      @@overwriting_method = false
+    end
+
+    def optionify(*method_names)
+      @@optionify_method_names = method_names
+      self.instance_methods(false).each do |mname|
+        self.overwrite_method_for_option(mname) if @@optionify_method_names.include?(mname)
+      end
+      @@overwriting_method = false
+    end
+
+    def method_added(name)
+      return if defined?(@@overwriting_method) && @@overwriting_method
+      if defined?(@@resultify_method_names) && @@resultify_method_names.include?(name)
+        self.overwrite_method_for_result(name)
+      end
+      if defined?(@@optionify_method_names) && @@optionify_method_names.include?(name)
+        self.overwrite_method_for_option(name)
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end

data/resultify.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "resultify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "resultify"
+  spec.version       = Resultify::VERSION
+  spec.authors       = ["Akshay Takkar"]
+  spec.email         = ["akshayt@m3india.in"]
+
+  spec.summary       = "Implementation for functional concepts like Maybe in Haskell and Result/Option in Rust."
+  spec.description   = "Implementation for functional concepts like Maybe in Haskell and Result/Option in Rust."
+  spec.homepage      = "https://github.com/blackblood"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/blackblood"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: resultify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akshay Takkar
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Implementation for functional concepts like Maybe in Haskell and Result/Option
+  in Rust.
+email:
+- akshayt@m3india.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resultify.rb
+- lib/resultify/version.rb
+- resultify.gemspec
+homepage: https://github.com/blackblood
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/blackblood
+  source_code_uri: https://github.com/blackblood
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key:
+specification_version: 4
+summary: Implementation for functional concepts like Maybe in Haskell and Result/Option
+  in Rust.
+test_files: []