rstructural 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eaeeb6fd3715a08c65d789c7c7566bd01cdf85889c2f75e3680c147899d1f35c
+  data.tar.gz: 77219c7fdcba9a170bb8e89150ea15b52fed139132c856503a2209cfb1356fd6
+SHA512:
+  metadata.gz: 5a81b38f7fa790f0a11b96c8d5dd0b85d8a30a812c34948c46027c75b5a8109b45411a636a708d2b36b8bb19e9271e48c923134199ca02776bd2eb5248d43435
+  data.tar.gz: 77fe704bffc450ec21394ad2f098a5f6911b5132546c55d60e390bd803764930485679bf743bef918464981efa133e16f7c8fc473d578a1e225bcba00629b6ab

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

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 violethero0820@gmail.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rstructural.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    rstructural (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    minitest (5.13.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rstructural!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 petitviolet
+
+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,141 @@
+# Ruby structual types
+
+- Rstruct 
+    - Struct implemented with Ruby
+- Enum
+    - A set of constants
+- Algebraic Data Type(ADT)
+    - A set of objects
+    - A object is a constant or a set of objects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rstruct'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rstruct
+
+## Usage
+
+### Rstruct
+
+```ruby
+module RstructSample
+  # define a struct type
+  Value = Rstruct.new(:value)
+
+  puts Value.name #=> 'RstructSample::Value'
+  puts value = Value.new(100) #=> 'RstructSample::Value(value: 100)
+  puts value == Value.new(100) #=> true
+  puts value.value == 100 #=> true
+  case value
+    in Value[n] # pattern match (Ruby 2.7~)
+    puts "here! value: #{n}" #=> 'here! value: 100'
+  else
+    raise
+  end
+end
+```
+
+### Enum
+
+```ruby
+module EnumSample
+  # define enum
+  module Status
+    extend Enum
+
+    # method(:enum) creates a enum value
+    OK = enum 200
+    NotFound = enum 404
+    InternalServerError = enum 500 do
+      # add block to define custom methods
+      def message
+        "Something wrong"
+      end
+    end
+  end
+
+  puts Status::OK #=> EnumSample::Status::OK(value: 200)
+  puts Status::InternalServerError.message  #=> Something wrong
+
+  # find enum by value
+  case Status.of(404)
+  in Status::NotFound
+    puts "NotFound!!!" #=> NotFound!!!
+  else
+    raise
+  end
+end
+```
+
+### ADT
+
+```ruby
+module AdtSample
+  # define ADT
+  module Shape
+    extend ADT
+
+    # define a constant object
+    Point = const
+
+    # define a object with 1 attribute
+    Circle = data :radius do |mod|
+      def scale(i)
+        Circle.new(radius * i)
+      end
+      def area
+        3.14 * radius * radius
+      end
+    end
+    # define a object with 2 attributes
+    Rectangle = data :width, :height do |mod|
+      def area
+        width * height
+      end
+    end
+
+  end
+
+  puts Shape::Point #=> AdtSample::Shape::Point
+  puts Shape::Rectangle.new(3, 4) #=> AdtSample::Shape::Rectangle(width: 3, height: 4)
+  puts Shape::Rectangle.new(3, 4).area #=> 12
+  puts Shape::Circle.new(5).scale(2).area #=> 314.0
+
+  case Shape::Rectangle.new(1, 2)
+  in Shape::Rectangle[Integer => i, Integer => j] if j % 2 == 0
+    puts "here! rectangle #{i}, #{j}" #=> here! rectangle 1, 2
+  else
+    raise
+  end
+end
+```
+
+## 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/petitviolet/rstruct. 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/petitviolet/rstruct/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://petitviolet.mit-license.org/).
+
+## Code of Conduct
+
+Everyone interacting in the Rstruct project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/petitviolet/rstruct/blob/master/CODE_OF_CONDUCT.md).

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 "rstruct"
+
+# 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/rstructural.rb

@@ -0,0 +1,11 @@
+require_relative './rstructural/struct'
+require_relative './rstructural/enum'
+require_relative './rstructural/adt'
+
+module Rstructural
+end
+
+# alias
+Rstruct = Rstructural::Struct
+Enum = Rstructural::Enum
+ADT = Rstructural::ADT

data/lib/rstructural/adt.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative './struct'
+
+module Rstructural::ADT
+  def self.extended(klass)
+    @@adt_types ||= []
+  end
+
+  def const(value = nil, &block)
+    if value
+      Rstructural::Struct.new(:value, __caller: caller, &block).new(value)
+    else
+      Rstructural::Struct.new(__caller: caller, &block).new
+    end.tap do |k|
+      @@adt_types << k
+      def k.name
+        self.class.name
+      end
+    end
+  end
+
+  def data(*fields, &block)
+    Rstructural::Struct.new(*fields, __caller: caller, &block).tap { |k| @@adt_types << k.name }
+  end
+end

data/lib/rstructural/enum.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative './struct'
+
+module Rstructural::Enum
+  def self.extended(mod)
+    @@enum_values ||= []
+  end
+
+  def enum(value, &block)
+    if (type = of(value))
+      raise ArgumentError, "Enum '#{value}' already defined in #{type.name}"
+    end
+    Rstructural::Struct.new(:value, __caller: caller, &block).new(value).tap do |k|
+      @@enum_values << k
+      def k.name
+        self.class.name
+      end
+    end
+  end
+
+  def of(value)
+    @@enum_values.find { |v| v.value == value }
+  end
+end
+

data/lib/rstructural/struct.rb

@@ -0,0 +1,56 @@
+module Rstructural
+  module Struct
+    def self.new(*attributes, __caller: nil, &block)
+      begin
+        kaller = __caller || caller
+        names = kaller.map do |stack|
+          # ".../hoge.rb:7:in `<module:Hoge>'"
+          if (m = stack.match(/\A.+in `<(module|class):(.+)>.+/))
+            m[2]
+          end
+        end.reject(&:nil?).reverse
+        file_name, line_num = kaller[0].split(':')
+        line_executed = File.readlines(file_name)[line_num.to_i - 1]
+        names << line_executed.match(/\A\s*(\S+)\s*=/)[1] # "  Point = Struct.new(:x, :y)\n"
+        class_name = names.join('::')
+      rescue StandardError
+        class_name = 'Struct'
+      end
+      Class.new.tap do |k|
+        k.class_eval <<~RUBY
+        def initialize(#{attributes.join(', ')})
+          #{attributes.map { |attr| "@#{attr} = #{attr}" }.join("\n")}
+        end
+
+        #{attributes.map { |attr| "attr_reader(:#{attr})" }.join("\n")}
+
+        def self.name
+          "#{class_name}"
+        end
+
+        def ==(other)
+          return false if other.class != self.class
+          #{attributes.map { |attr| "other.#{attr} == self.#{attr}" }.join(" && ")}
+        end
+
+        def inspect
+          if #{attributes.empty?}
+            "#{class_name}"
+          else
+            __attrs = Array[#{attributes.map { |attr| "'#{attr}: ' + @#{attr}.to_s" }.join(', ')}].join(", ")
+            "#{class_name}(" + __attrs + ")"
+          end
+        end
+
+        alias :to_s :inspect
+
+        def deconstruct
+          [#{attributes.map { |attr| "@#{attr}" }.join(', ')}]
+        end
+        RUBY
+        k.class_eval(&block) if block
+      end
+    end
+  end
+end
+

data/rstructural.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "rstructural"
+  spec.version       = "0.1.1"
+  spec.authors       = ["petitviolet"]
+  spec.email         = ["violethero0820@gmail.com"]
+
+  spec.summary       = %q{A kind of structural types for Ruby}
+  spec.description   = %q{Structural types, Struct, Enum and ADT for Ruby implemented with Ruby}
+  spec.homepage      = "https://github.com/petitviolet/rstructural"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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("^(\.git*|sample|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 "byebug"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rstructural
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- petitviolet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Structural types, Struct, Enum and ADT for Ruby implemented with Ruby
+email:
+- violethero0820@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rstructural.rb
+- lib/rstructural/adt.rb
+- lib/rstructural/enum.rb
+- lib/rstructural/struct.rb
+- rstructural.gemspec
+homepage: https://github.com/petitviolet/rstructural
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/petitviolet/rstructural
+  source_code_uri: https://github.com/petitviolet/rstructural
+  changelog_uri: https://github.com/petitviolet/rstructural
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A kind of structural types for Ruby
+test_files: []