emu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80e58ff8f1a11f69581ad745836d6a0af99aae8e46b51615d154f3114730c250
+  data.tar.gz: 942c66c48155f9298b0069df9a35dfa5ea96f0895e2cc8403a5f4441e8778e57
+SHA512:
+  metadata.gz: aecb49f1cd38e186d347cdbe4991a091e4e8318f48d87bd553b1c8da7aae61277bedbab55fcbc78fc9da876b96af974f44e95783f202cc0a776313646f1e4e9f
+  data.tar.gz: 4146a50e2062ae91ceb7a403e5510602a4725fa4c4320fa82fa6f40c41cc268bd2eb294732f3e724efd637df9767dd02b771a92b7e8b7038054eb032065fffc1

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in emu.gemspec
+gemspec
+
+gem "rake", "~> 12.3"
+gem "minitest", "~> 5.0"
+# Used for documentation output of minitest
+gem "minitest-reporters", "~> 1.3"
+gem "yard", "~> 0.9"
+
+gem 'simplecov', group: :test, require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tim Habermaas
+
+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,39 @@
+# Emu
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/emu`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'emu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install emu
+
+## 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 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/[USERNAME]/emu.
+
+## 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,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "emu"
+
+# 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/emu.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "emu/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "emu"
+  spec.version       = Emu::VERSION
+  spec.authors       = ["Tim Habermaas"]
+  spec.email         = ["emu@timhabermaas.com"]
+
+  spec.summary       = %q{Composable decoding library in the spirit of Json.Decode from Elm}
+  spec.description   = %q{Emu acts as a replacement for ad-hoc type coercions and strong_parameters.}
+  spec.homepage      = "https://github.com/timhabermaas/emu.git"
+  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"] = "TODO: Put your gem's public repo URL here."
+    #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.
+  spec.files         = ["Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "emu.gemspec",
+                        "lib/emu.rb", "lib/emu/version.rb", "lib/emu/decoder.rb", "lib/emu/result.rb"]
+  spec.bindir        = "exe"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  #spec.add_development_dependency "rake", "~> 10.0"
+  #spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/emu.rb

@@ -0,0 +1,119 @@
+require "emu/version"
+require "emu/result"
+require "emu/decoder"
+
+module Emu
+
+  # Creates a decoder which only accepts strings.
+  #
+  # @example
+  #   Emu.string.run!("2") # => "2"
+  #   Emu.string.run!(2) # => raise DecodeError, "`2` is not a String"
+  # @return [Emu::Decoder<String>]
+  def self.string
+    Decoder.new do |s|
+      next Err.new("`#{s.inspect}` is not a String") unless s.is_a?(String)
+
+      Ok.new(s)
+    end
+  end
+
+  def self.str_to_int
+    Decoder.new do |s|
+      next Err.new("`#{s.inspect}` is not a String") unless s.is_a?(String)
+
+      begin
+        Ok.new(Integer(s))
+      rescue TypeError, ArgumentError
+        Err.new("`#{s.inspect}` can't be converted to an integer")
+      end
+    end
+  end
+
+  def self.integer
+    Decoder.new do |i|
+      next Err.new("`#{i.inspect}` is not an Integer") unless i.is_a?(Integer)
+
+      Ok.new(i)
+    end
+  end
+
+  def self.boolean
+    Decoder.new do |b|
+      next Err.new("`#{b.inspect}` is not a Boolean") unless b.is_a?(TrueClass) || b.is_a?(FalseClass)
+
+      Ok.new(b)
+    end
+  end
+
+  def self.str_to_bool
+    Decoder.new do |s|
+      next Err.new("`#{s.inspect}` is not a String") unless s.is_a?(String)
+
+      if s == "true" || s == "1"
+        Ok.new(true)
+      elsif s == "false" || s == "0"
+        Ok.new(false)
+      else
+        Err.new("`#{s.inspect}` can not be converted to a Boolean")
+      end
+    end
+  end
+
+  def self.id
+    Decoder.new do |s|
+      Ok.new(s)
+    end
+  end
+
+  def self.succeed(v)
+    Decoder.new do |_|
+      Ok.new(v)
+    end
+  end
+
+  def self.fail(e)
+    Decoder.new do |_|
+      Err.new(e)
+    end
+  end
+
+  # Returns a decoder which succeeds if the input value matches ++constant++.
+  # #== is used for comparision, no type checks are performed.
+  #
+  # @example
+  #   Emu.match(42).run!(42) # => 42
+  #   Emu.match(42).run!(41) # => raise DecodeError, "`41` doesn't match `42`"
+  # @param constant [Object] the value to match against
+  # @return [Emu::Decoder<Object>]
+  def self.match(constant)
+    Decoder.new do |s|
+      s == constant ? Ok.new(s) : Err.new("`#{s.inspect}` doesn't match `#{constant.inspect}`")
+    end
+  end
+
+  def self.from_key(key, decoder)
+    Decoder.new do |hash|
+      next Err.new("'#{hash}' doesn't contain key '#{key}'") unless hash.has_key?(key)
+
+      decoder.run(hash.fetch(key))
+    end
+  end
+
+  def self.map_n(*decoders, &block)
+    raise "decoder count must match argument count of provided block" unless decoders.size == block.arity
+
+    Decoder.new do |input|
+      results = decoders.map do |c|
+        c.run(input)
+      end
+
+      first_error = results.find(&:error?)
+      if first_error
+        first_error
+      else
+        Ok.new(block.call(*results.map(&:unwrap)))
+      end
+    end
+  end
+end

data/lib/emu/decoder.rb

@@ -0,0 +1,57 @@
+module Emu
+  class DecodeError < StandardError
+  end
+
+  class Decoder
+    def initialize(&block)
+      @f = block
+    end
+
+    def run(value)
+      @f.call(value)
+    end
+
+    def run!(value)
+      result = run(value)
+      if result.error?
+        raise DecodeError, result.unwrap_err
+      else
+        result.unwrap
+      end
+    end
+
+    def fmap
+      Decoder.new do |input|
+        result = run(input)
+        if result.error?
+          result
+        else
+          Ok.new(yield result.unwrap)
+        end
+      end
+    end
+
+    def then
+      Decoder.new do |input|
+        run(input).then do |result|
+          (yield result).run(input)
+        end
+      end
+    end
+
+    def |(decoder)
+      Decoder.new do |input|
+        result = run(input)
+        if result.error?
+          decoder.run(input)
+        else
+          result
+        end
+      end
+    end
+
+    def >(value)
+      fmap { |_| value }
+    end
+  end
+end

data/lib/emu/result.rb

@@ -0,0 +1,53 @@
+module Emu
+  class Err
+    def initialize(error)
+      @error = error
+    end
+
+    def to_s
+      "Err(#{@error})"
+    end
+
+    def then
+      self
+    end
+
+    def unwrap
+      raise "can't unwrap Err(#{@error.inspect})"
+    end
+
+    def unwrap_err
+      @error
+    end
+
+    def error?
+      true
+    end
+  end
+
+  class Ok
+    def initialize(value)
+      @value = value
+    end
+
+    def to_s
+      "Ok(#{@value})"
+    end
+
+    def then
+      yield @value
+    end
+
+    def unwrap
+      @value
+    end
+
+    def unwrap_err
+      raise "can't unwrap_err Ok(#{@value.inspect})"
+    end
+
+    def error?
+      false
+    end
+  end
+end

data/lib/emu/version.rb

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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: emu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Habermaas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-23 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'
+description: Emu acts as a replacement for ad-hoc type coercions and strong_parameters.
+email:
+- emu@timhabermaas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- emu.gemspec
+- lib/emu.rb
+- lib/emu/decoder.rb
+- lib/emu/result.rb
+- lib/emu/version.rb
+homepage: https://github.com/timhabermaas/emu.git
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 3.0.0.beta1
+signing_key: 
+specification_version: 4
+summary: Composable decoding library in the spirit of Json.Decode from Elm
+test_files: []