kt_data_class 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07f4f37597afbff2e75aa9132f44f00e1496d7451228ac61622116a90723109e
+  data.tar.gz: 0b3ac170ffdbbde406f76b1354bf5e7471486698f4e54e413583d48017cea832
+SHA512:
+  metadata.gz: 304dbdb54529139130390ee98d20468e92f10f0a391a401fa2e6d2a7fe6287f67247337ae0a3fa672d2b4fdb031f1715a43c144f984b24368397167258560e88
+  data.tar.gz: 5ca39bda402610f31a4e0bc4bb0542d88da2be15cd788f8197bcc32062f29804bf68097b55acf1957088155f7b4b07adde49bfe6dfd46e3a2808d40e5d9c91c6

data/.circleci/config.yml

@@ -0,0 +1,32 @@
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.3.8
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --path vendor/bundle
+
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

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

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 kt_data_class.gemspec
+gemspec

data/README.md

@@ -0,0 +1,96 @@
+# KtDataClass
+
+Kotlinの
+
+```
+data class Point(val x: Int, val y: Int)
+
+val p1 = Point(3, 4)
+```
+
+のように書けるやつをRubyで作ってみようという試み。
+
+## Feature
+
+### Basic usage
+
+```
+Point = KtDataClass.create(:x, :y)
+p1 = Point.new(x: 3, y: 4)
+
+puts p1.x, p1.y
+```
+
+Also, some convenient methods can be added like below:
+
+```
+Point = KtDataClass.create(:x, :y) do
+  def -(other)
+    self.class.new(x: x - other.x, y: y - other.y)
+  end
+
+  def norm
+    Math.sqrt(x * x + y * y)
+  end
+end
+
+(Point.new(x: 4, y: 5) - Point.new(x: 1, y: 1)).norm
+# => 5.0
+```
+
+### Immutable
+
+```
+Profile = KtDataClass.create(:hobby)
+profile = Profile.new(hobby: "Ruby")
+
+profile.hobby = "Python"
+# NoMethodError: undefined method `hobby=' for #<Profile:0x0000000000ee2668 @hobby="Ruby">
+
+new_profile = profile.copy(hobby: "Python")
+
+profile.hobby
+# => "Ruby"
+new_profile.hobby
+# => "Python"
+```
+
+### Destructuring assignment
+
+```
+Point = KtDataClass.create(:x, :y)
+p = Point.new(x: 1, y: 2)
+x, y = p
+
+x
+# => 1
+
+y
+# => 2
+```
+
+## FAQ
+
+### How can I define default value?
+
+In Kotlin,
+
+```
+data class Point(x: Int = 0, y: Int = 0)
+```
+
+This can be implemented by overriding constructor like below:
+
+```
+Point = KtDataClass.create(:x, :y) do
+  def initialize(x: 0, y: 0)
+    super
+  end
+end
+
+Point.new
+# => #<Point:0x00000000020c5b78 @x=0, @y=0>
+
+Point.new(x: 1)
+# => #<Point:0x00000000020a90e0 @x=1, @y=0>
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

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

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kt_data_class/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kt_data_class"
+  spec.version       = KtDataClass::VERSION
+  spec.authors       = ["YusukeIwaki"]
+  spec.email         = ["yusuke.iwaki@crowdworks.co.jp"]
+
+  spec.summary       = "The Ruby porting of `data class` in Kotlin"
+  spec.homepage      = "https://github.com/YusukeIwaki/kt_data_class"
+
+  # 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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
+end

data/lib/kt_data_class.rb

@@ -0,0 +1,12 @@
+require "kt_data_class/version"
+require "kt_data_class/definition"
+require "kt_data_class/factory"
+
+module KtDataClass
+  def create(*attr_names, **kwargs, &block)
+    definition = Definition.new(attr_names, kwargs)
+    Factory.new(definition).create(&block)
+  end
+
+  module_function :create
+end

data/lib/kt_data_class/base.rb

@@ -0,0 +1,57 @@
+module KtDataClass
+  class Base
+    def initialize(*args, **kwargs)
+      unless args.empty?
+        raise ArgumentError.new("data class must be initialized with keyword arguments.")
+      end
+
+      (self.class.definition.keys - kwargs.keys).each do |missing_key|
+        raise ArgumentError.new("missing keyword: #{missing_key}")
+      end
+      (kwargs.keys - self.class.definition.keys).each do |unknown_key|
+        raise ArgumentError.new("unknown keyword: #{unknown_key}")
+      end
+
+      kwargs.each do |attr_name, value|
+        instance_variable_set("@#{attr_name}", value)
+      end
+    end
+
+    def copy(*args, **kwargs)
+      unless args.empty?
+        raise ArgumentError.new("parameters for copying must be keyword arguments.")
+      end
+      new_params = hash.merge(kwargs)
+      self.class.new(**new_params)
+    end
+
+    def hash
+      self.class.definition.keys.inject(Hash.new) do |h, attr_name|
+        h[attr_name] = instance_variable_get("@#{attr_name}")
+        h
+      end
+    end
+    alias_method :to_h, :hash
+    alias_method :to_hash, :hash
+
+    # @see http://maeharin.hatenablog.com/entry/20130107/p1
+    def to_ary
+      self.class.definition.keys.map do |attr_name|
+        instance_variable_get("@#{attr_name}")
+      end
+    end
+    alias_method :to_a, :to_ary
+
+    def to_s
+      hash.to_s
+    end
+
+    def ==(other)
+      self.hash == other.hash
+    end
+
+    def eql?(other)
+      self.class == other.class && self.hash.eql?(other.hash)
+    end
+  end
+end

data/lib/kt_data_class/definition.rb

@@ -0,0 +1,29 @@
+module KtDataClass
+  class InvalidDefinitionError < ArgumentError ; end
+
+  class Definition
+    # @param [Array<Symbol>] attr_names
+    # @param [Hash] kwargs 空じゃないものを渡すと例外が発生する
+    def initialize(attr_names, kwargs = {})
+      raise_if_invalid(attr_names, kwargs)
+      @attr_names = attr_names
+    end
+
+    def keys
+      @attr_names
+    end
+
+    private
+
+    def raise_if_invalid(attr_names, kwargs)
+      if !kwargs.empty? || !attr_names.is_a?(Array) || attr_names.any?{ |attr_name| !attr_name.is_a?(Symbol) }
+        raise InvalidDefinitionError.new("class definition must be specified with Array of Symbols")
+      end
+      duplicated_names = attr_names.group_by{|attr_name| attr_name}.values.select{|names| names.count >= 2}
+      unless duplicated_names.empty?
+        attr_names = duplicated_names.map(&:first)
+        raise InvalidDefinitionError.new("each argument is allowed to use only once. [#{attr_names.join(", ")}] has been used more than once.")
+      end
+    end
+  end
+end

data/lib/kt_data_class/factory.rb

@@ -0,0 +1,24 @@
+require "kt_data_class/base"
+
+module KtDataClass
+  class Factory
+    # @param [Definition] definition
+    def initialize(definition)
+      @definition = definition
+    end
+
+    def create(&block)
+      member_definition = @definition
+      Class.new(Base) do
+        define_singleton_method(:definition) do
+          member_definition
+        end
+        attr_reader(*member_definition.keys)
+
+        unless block.nil?
+          class_eval(&block)
+        end
+      end
+    end
+  end
+end

data/lib/kt_data_class/version.rb

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: kt_data_class
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- YusukeIwaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: 
+email:
+- yusuke.iwaki@crowdworks.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kt_data_class.gemspec
+- lib/kt_data_class.rb
+- lib/kt_data_class/base.rb
+- lib/kt_data_class/definition.rb
+- lib/kt_data_class/factory.rb
+- lib/kt_data_class/version.rb
+homepage: https://github.com/YusukeIwaki/kt_data_class
+licenses: []
+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: 2.7.7
+signing_key: 
+specification_version: 4
+summary: The Ruby porting of `data class` in Kotlin
+test_files: []