data_class_factory 0.0.beta0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13db8d588b7024e13dd87db5fade13f9b00c87a6ba480d43361ea51dc9494296
-  data.tar.gz: 3b1f1c66790b23e8fd87557afb30979655af70687fff44c459707716ba25f5de
+  metadata.gz: 85a61ac673bb16b61d606b2a332aada35a31ae1e62d0db7140fbe88f1598d84a
+  data.tar.gz: c0533d7643ef9eaca60995f7d35797179f55471f883fb15c943e9ef53a1d95a6
 SHA512:
-  metadata.gz: a84caf0dcadf17210bdd61a4ea284c1b2d54a1c4231ae2a72feca44a654ea52f4e8cdc0d6af64981d6f2b10cbfca1938487ff7bb2f934a3f6156d2253ac9d406
-  data.tar.gz: 06c62651ce5e6de2c63666b084f18010d5b1ce5bcdd033674bb88cf5960d67f101f0d5e00b376b9d54b5584e5592225812805ea56d70edfbc5ad189b54e2b0a9
+  metadata.gz: bcb368e9071a14ba6da85043a57d46897ab9ee016e9587ca674964c8a39858a6be0e476f47db94718db761efd4896e0b3db156eca1457ca6294e5b8fdb535b22
+  data.tar.gz: 1f5ca0c39dbd680fd81b6587fce069a05f5653f6b898e806a22a7ca3831572596f1218dff47bd898994492ae447b38e8fc58dcdb134b8c73e0d8b457948c2ed9

data/Gemfile

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

data/README.md

@@ -1,38 +1,67 @@
-# DataClassFactory
+[![Gem Version](https://badge.fury.io/rb/data_class_factory.svg)](https://badge.fury.io/rb/data_class_factory)
 
-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/data_class_factory`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Data class factory
 
-TODO: Delete this and the text above, and describe your gem
+Backport `Data.define` for Ruby 2.7, 3.0, 3.1 :)
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'data_class_factory'
 ```
 
-And then execute:
+and then `bundle install`
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+```ruby
+require 'data_class_factory'
+
+Point = Data.define(:x, :y) do
+  def norm
+    Math.sqrt(x * x + y * y)
+  end
+end
+p1 = Point.new(x: 3, y: 4)
+p2 = Point.new(x: 3, y: 4)
+p1 == p2 # => true
+```
 
-    $ gem install data_class_factory
+Most features of the data class are ported. See https://docs.ruby-lang.org/en/3.2/Data.html for checking the original spec of `Data`.
 
-## Usage
+One difference is that backported Data class intentionally accepts only keyword arguments for `.new` while original Data class accepts both positional args and keyword args.
 
-TODO: Write usage instructions here
+```ruby
+Point = Data.define(:x, :y) do
+  def norm
+    Math.sqrt(x * x + y * y)
+  end
+end
 
-## Development
+# raises ArgumentError
+#          wrong number of arguments (given 2, expected 0)
+p1 = Point.new(3, 4)
 
-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.
+p1 = Point.new(x: 3, y: 4) # works well :)
+```
 
-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).
+### aliasing
 
-## Contributing
+REMARK this gem removes `Data` [defined on Ruby 2.7](https://ruby-doc.org/core-2.7.0/Data.html), and respects original `Data` on Ruby >= 3.2. If you prefer using this gem also on Ruby >= 3.2, choose another name like this.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/data_class_factory. 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.
+```ruby
+MyDataClass = DataClassFactory.define_factory_class
+```
+
+We can use the aliased class as usual like below.
+
+```ruby
+Point = MyDataClass.define(:x, :y) do
+  def norm
+    Math.sqrt(x * x + y * y)
+  end
+end
+```
 
 ## License
 
@@ -40,4 +69,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the DataClassFactory project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/data_class_factory/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the DataClassFactory project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,8 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+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"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "data_class_factory"
+require 'bundler/setup'
+require 'data_class_factory'
 
 # 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.
@@ -10,5 +11,5 @@ require "data_class_factory"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/data_class_factory.gemspec

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "data_class_factory/version"
+require 'data_class_factory/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "data_class_factory"
+  spec.name          = 'data_class_factory'
   spec.version       = DataClassFactory::VERSION
-  spec.authors       = ["YusukeIwaki"]
+  spec.authors       = ['YusukeIwaki']
 
-  spec.summary       = "Backport `Data.define` for Ruby < 3.2"
-  spec.homepage      = "https://github.com/YusukeIwaki/data_class_factory"
-  spec.license       = "MIT"
+  spec.summary       = 'Backport `Data.define` for Ruby 2.7, 3.0, 3.1'
+  spec.homepage      = 'https://github.com/YusukeIwaki/data_class_factory'
+  spec.license       = 'MIT'
 
   # 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.
@@ -19,12 +20,15 @@ Gem::Specification.new do |spec|
       f.match(%r{^(test|spec|features)/}) || f.include?('.git')
     end
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.7'
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-minitest'
 end

data/lib/data.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.0.0')
+  warn 'Removing original `Data` class', uplevel: 3
+  Object.send(:remove_const, :Data)
+end
+Data = DataClassFactory.define_factory_class if DataClassFactory.backport?

data/lib/data_class/definition.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module DataClass
+  # An internal class for providing validation of `Data.define` and its initializer.
+  class Definition
+    # @param attribute_names [Array<Symbol>]
+    def initialize(attribute_names)
+      validate_attribute_names(attribute_names)
+      @attribute_names = attribute_names.each { |key| validate_attribute_name(key) }
+    end
+    attr_reader :attribute_names
+
+    # @param kwargs [Hash<Symbol, Object>]
+    def validate(kwargs)
+      if attribute_names - kwargs.keys != []
+        raise ArgumentError, "missing keyword: #{(attribute_names - kwargs.keys).join(', ')}"
+      end
+
+      if kwargs.keys - attribute_names != []
+        raise ArgumentError, "unknown keyword: #{(kwargs.keys - attribute_names).join(', ')}"
+      end
+
+      nil
+    end
+
+    private
+
+    def validate_attribute_names(attribute_names)
+      checked = Set.new
+      attribute_names.each do |key|
+        raise TypeError, "#{key} is not a symbol" unless key.is_a?(Symbol)
+        raise ArgumentError, "invalid data member: #{key}" if key.end_with?('=')
+        raise ArgumentError, "duplicate member: #{key}" if checked.include?(key)
+
+        checked << key
+      end
+    end
+
+    def validate_attribute_name(key); end
+  end
+end

data/lib/data_class/factory.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DataClass
+  # An internal class for providing implementation of `Data.define`.
+  class Factory
+    # @param attribute_names [Array<Symbol>]
+    def initialize(attribute_names)
+      @definition = Definition.new(attribute_names)
+    end
+
+    # @param parent_class [Data]
+    # @return [Class<Data>]
+    def create(parent_class:, &block)
+      attribute_names = @definition.attribute_names
+
+      # defines a subclass of Data.
+      Class.new(parent_class) do
+        public_class_method :new
+        private_class_method :define
+
+        attribute_names.each { |key| define_method(key) { @data[key] } }
+
+        define_singleton_method(:members) { attribute_names }
+
+        class_eval(&block) unless block.nil?
+      end
+    end
+  end
+end

data/lib/data_class/instance_methods.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module DataClass
+  # An internal module for providing instance methods for `Data.define`.
+  module InstanceMethods
+    def initialize(**kwargs)
+      definition = DataClass::Definition.new(self.class.members)
+      definition.validate(kwargs)
+
+      @data = kwargs.each_with_object({}) do |entry, h|
+        key, value = entry
+        h[key] = value
+      end.freeze
+      freeze
+    end
+
+    def initialize_copy(other)
+      @data = other.instance_variable_get(:@data).dup
+      @data.freeze
+      freeze
+    end
+
+    def deconstruct
+      @data.values
+    end
+
+    # @param array_of_names_or_nil [Array<Symbol>, nil]
+    def deconstruct_keys(array_of_names_or_nil)
+      return to_h if array_of_names_or_nil.nil?
+
+      unless array_of_names_or_nil.is_a?(Enumerable)
+        raise TypeError, "wrong argument type #{array_of_names_or_nil.class} (expected Array or nil)"
+      end
+
+      array_of_names_or_nil.each_with_object({}) do |key, h|
+        h[key] = @data[key] if @data[key]
+      end
+    end
+
+    # @return [Boolean]
+    def eql?(other)
+      hash_for_comparation.eql?(other.hash_for_comparation)
+    end
+
+    # @return [Integer]
+    def hash
+      hash_for_comparation.hash
+    end
+
+    # @return [String]
+    def inspect
+      if self.class.name
+        "#<data #{self.class.name} #{inspect_members}>"
+      else
+        "#<data #{inspect_members}>"
+      end
+    end
+
+    # @return [Hash]
+    def marshal_dump
+      @data
+    end
+
+    # @param dump [Hash]
+    def marshal_load(dump)
+      raise TypeError, 'dump must be a Hash' unless dump.is_a?(Hash)
+
+      initialize(**dump)
+    end
+
+    def members
+      self.class.members
+    end
+
+    def to_h(&block)
+      @data.each_with_object({}) do |key_and_value, h|
+        key, value = block ? block.call(*key_and_value) : key_and_value
+        h[key] = value
+      end.to_h
+    end
+
+    def to_s
+      inspect
+    end
+
+    def with(**kwargs)
+      return self if kwargs.empty?
+
+      unknown_keywords = kwargs.keys - @data.keys
+      raise ArgumentError, "unknown keywords: #{unknown_keywords.join(', ')}" unless unknown_keywords.empty?
+
+      new_data = @data.merge(kwargs)
+      self.class.new(**new_data)
+    end
+
+    # @return [Boolean]
+    def ==(other)
+      hash_for_comparation == other.hash_for_comparation
+    end
+
+    protected
+
+    def hash_for_comparation
+      { type: self.class, data: @data }
+    end
+
+    private
+
+    # @return [String]
+    def inspect_members
+      @data.map do |key, value|
+        if key =~ /\A[a-zA-Z_][a-zA-Z0-9_]*\z/
+          "#{key}=#{value.inspect}"
+        else
+          "#{key.inspect}=#{value.inspect}"
+        end
+      end.join(', ')
+    end
+  end
+end

data/lib/data_class_factory/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DataClassFactory
-  VERSION = "0.0.beta0"
+  VERSION = '0.1.0'
 end

data/lib/data_class_factory.rb

@@ -1,6 +1,40 @@
-require "data_class_factory/version"
+# frozen_string_literal: true
 
+require 'data_class_factory/version'
+require 'data_class/definition'
+require 'data_class/factory'
+require 'data_class/instance_methods'
+
+# Defining a factory class.
+# `Data = DataClassFactory.define_factory_class` will define a factory class like this.
+#
+#    class Data
+#      # @param attribute_names [Array<Symbol>]
+#      # @return [Class<Data>]
+#      def self.define(*attribute_names, &block)
+#        factory = DataClass::Factory.new(attribute_names)
+#        factory.create(parent_class: self, &block)
+#      end
+#      ...
+#    end
+#
 module DataClassFactory
-  class Error < StandardError; end
-  # Your code goes here...
+  def backport?
+    Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.2.0')
+  end
+
+  def define_factory_class
+    Class.new do
+      define_singleton_method(:define) do |*attribute_names, &block|
+        factory = DataClass::Factory.new(attribute_names)
+        factory.create(parent_class: self, &block)
+      end
+      private_class_method :new
+
+      include DataClass::InstanceMethods
+    end
+  end
+  module_function :backport?, :define_factory_class
 end
+
+require_relative './data'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_class_factory
 version: !ruby/object:Gem::Version
-  version: 0.0.beta0
+  version: 0.1.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-05 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +108,10 @@ files:
 - bin/console
 - bin/setup
 - data_class_factory.gemspec
+- lib/data.rb
+- lib/data_class/definition.rb
+- lib/data_class/factory.rb
+- lib/data_class/instance_methods.rb
 - lib/data_class_factory.rb
 - lib/data_class_factory/version.rb
 homepage: https://github.com/YusukeIwaki/data_class_factory
@@ -83,12 +129,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
-summary: Backport `Data.define` for Ruby < 3.2
+summary: Backport `Data.define` for Ruby 2.7, 3.0, 3.1
 test_files: []