sumaki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 743c9cc65c7fb7b06a254d6f96ccacd405101fbd87b12b9ba9a0283341f0203b
+  data.tar.gz: 922c9652b6a0bee5fcca21e261b653a8fe9362ad0ee174050f6a0e8fae9986d1
+SHA512:
+  metadata.gz: 3d368a98fe977ba95aad3b0d01233a46eb00391e0c2825faa6b4fe9991b6394808a90dbfe37af1648ddf3bed13b904fb3dee72f5ee83237c4c0d876a628df660
+  data.tar.gz: 122196f48283f4e23f3a9ba52d84aff764487066016da59bb42e5fe5e405780bde902f41bf45bc25ead3b6fcc5347935b786d4723e17328f137052b0ff0836ed

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+require: rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/sumaki/model/association_spec.rb'
+    - 'spec/sumaki/model/attribute_spec.rb'
+    - 'spec/sumaki/model/enum_spec.rb'
+
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/sumaki/model/association_spec.rb'
+    - 'spec/sumaki/model/attribute_spec.rb'
+    - 'spec/sumaki/model/enum_spec.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sumaki.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'debug'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', require: false
+gem 'rubocop-rspec', require: false
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    sumaki (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    io-console (0.6.0)
+    irb (1.6.2)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    reline (0.3.2)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rspec
+  simplecov
+  sumaki!
+
+BUNDLED WITH
+   2.4.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Loose Coupling
+
+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,251 @@
+# Sumaki
+
+---
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/dd92d4092d6858cbcfb2/maintainability)](https://codeclimate.com/github/nowlinuxing/sumaki/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/dd92d4092d6858cbcfb2/test_coverage)](https://codeclimate.com/github/nowlinuxing/sumaki/test_coverage)
+
+**Sumaki** is a wrapper for structured data like JSON.
+
+Since Sumaki wraps the target data as it is, rather than parsing it using a schema, the original data can be referenced at any time.
+
+This makes it easy to add or modify definitions as needed while checking the target data.
+
+This feature may be useful when there is no document defining the structure of the data, or when the specification is complex and difficult to grasp, and the definition is written little by little starting from the obvious places.
+
+```ruby
+class AnimeList
+  include Sumaki::Model
+  repeated :anime
+  field :name
+
+  class Anime
+    include Sumaki::Model
+    singular :studio
+    field :title
+
+    class Studio
+      include Sumaki::Model
+      field :name
+    end
+  end
+end
+
+data = {
+  name: 'Winter 2023',
+  anime: [
+    {
+      title: 'The Vampire Dies in No Time',
+      studio: {
+        name: 'MADHOUSE Inc.'
+      }
+    },
+    {
+      title: '“Ippon” again!',
+      studio: {
+        name: 'BAKKEN RECORD'
+      }
+    }
+  ]
+}
+
+anime_list = AnimeList.new(data)
+anime_list.name #=> 'Winter 2023'
+anime_list.anime[0].title #=> 'The Vampire Dies in No Time'
+anime_list.anime[0].studio.name #=>  'MADHOUSE Inc.'
+anime_list.anime[0].object #=> { title: 'The Vampire Dies in No Time', studio: { name: 'MADHOUSE Inc.' } }
+```
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add sumaki
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install sumaki
+
+## Usage
+
+Include `Sumaki::Model` module in the class that wraps the data, and give the data when creating the instance.
+
+```ruby
+class Anime
+  include Sumaki::Model
+end
+
+Anime.new({})
+```
+
+Only this does not give access to fields or structured data, so the following declarations need to be added.
+
+### Access to the fields
+
+By declaring `field`, you can access the field.
+
+```ruby
+class Anime
+  include Sumaki::Model
+  field :title
+  field :url
+end
+
+anime = Anime.new({ title: 'The Vampire Dies in No Time', url: 'https://sugushinu-anime.jp/' })
+anime.title #=> 'The Vampire Dies in No Time'
+anime.url #=> 'https://sugushinu-anime.jp/'
+```
+
+If the data contains attributes not declared in the field, it raises no error and is simply ignored.
+
+### Access to the sub object
+
+By declaring `singular`, you can access the sub object.
+
+```ruby
+class Book
+  include Sumaki::Model
+  singular :company
+  field :title
+
+  class Company
+    include Sumaki::Model
+    field :name
+    field :prefecture
+  end
+end
+
+data = {
+  title: 'The Ronaldo Chronicles',
+  company: {
+    name: 'Autumn Books',
+    prefecture: 'Tokyo'
+  }
+}
+
+comic = Book.new(data)
+comic.company.name #=> 'Autumn Books'
+```
+
+sub object is wrapped with the class inferred from the field name under the original class.
+
+This can be changed by specifying the class to wrap.
+
+```ruby
+class Book
+  include Sumaki::Model
+  singular :author, class_name: 'Character'
+  field :title
+
+  class Character
+    include Sumaki::Model
+    field :name
+  end
+end
+
+data = {
+  title: 'The Ronaldo Chronicles',
+  author: {
+    name: 'Ronaldo'
+  }
+}
+
+book = Book.new(data)
+book.author.class #=> Book::Character
+```
+
+### Access to the repeated sub objects
+
+By declaring `repeated`, you can access the repeated sub objects as an Array.
+
+```ruby
+class Company
+  include Sumaki::Model
+  repeated :member
+  field :name
+
+  class Member
+    include Sumaki::Model
+    field :name
+  end
+end
+
+data = {
+  name: 'The Ronaldo Vampire Hunter Agency',
+  member: [
+    { name: 'Ronaldo' },
+    { name: 'Draluc' },
+    { name: 'John' }
+  ]
+}
+
+company = Company.new(data)
+company.member.size #=> 3
+company.member[2].name #=> 'John'
+```
+
+The `class_name` option can also be used to specify the class to wrap.
+
+### Access to the parent object
+
+Parent object can be referenced from sub object by `#parent` method.
+
+```ruby
+class Character
+  include Sumaki::Model
+  singular :child
+  field :name
+
+  class Child
+    include Sumaki::Model
+    field :name
+  end
+end
+
+data = {
+  name: 'Draus',
+  child: {
+    name: 'Draluc'
+  }
+}
+
+character = Character.new(data)
+character.child.name #=> 'Draluc'
+character.child.parent.name #=> 'Draus'
+```
+
+### Enumerations
+
+By declaring `enum`, You can map a field to the specified value.
+
+```ruby
+class Character
+  include Sumaki::Model
+  field :name
+  enum :type, vampire: 1, vampire_hunter: 2, familier: 3, editor: 4
+end
+
+data = {
+  name: 'John',
+  type: 3
+}
+
+character = Character.new(data)
+character.type #=> :familier
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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]/sumaki.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sumaki/adapter/hash.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sumaki
+  module Adapter
+    # = Sumaki::Adapter::Hash
+    class Hash
+      def get(data, key)
+        data[key]
+      end
+    end
+  end
+end

data/lib/sumaki/adapter.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'adapter/hash'

data/lib/sumaki/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'adapter'
+
+module Sumaki
+  module Config # :nodoc:
+    singleton_class.attr_accessor :default_adapter
+
+    self.default_adapter = Sumaki::Adapter::Hash.new
+  end
+end

data/lib/sumaki/model/association.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Sumaki
+  module Model
+    # = Sumaki::Model::Association
+    module Association
+      def self.included(base)
+        base.extend ClassMethods
+        base.include InstanceMethods
+
+        base.instance_variable_set(:@classes, {})
+      end
+
+      module ClassMethods # :nodoc:
+        # Access to the sub object.
+        #
+        #   class Book
+        #     include Sumaki::Model
+        #     singular :company
+        #
+        #     class Company
+        #       include Sumaki::Model
+        #     end
+        #   end
+        #
+        #   data = {
+        #     title: 'The Ronaldo Chronicles',
+        #     company: {
+        #       name: 'Autumn Books',
+        #     }
+        #   }
+        #   book = Book.new(data)
+        #   book.company.class #=> Book::Company
+        #
+        # == Options
+        #
+        # [:class_name]
+        #   Specify the name of the class to wrap. Use this if the name of the class
+        #   to wrap is not inferred from the nested field names.
+        def singular(name, class_name: nil)
+          association_methods_module.define_method(name) do
+            klass = self.class.class_for(name, class_name)
+            klass.new(get(name), parent: self)
+          end
+        end
+
+        # Access to the repeated sub objects
+        #
+        #   class Company
+        #     include Sumaki::Model
+        #     repeated :member
+        #
+        #     class Member
+        #       include Sumaki::Model
+        #     end
+        #   end
+        #
+        #   data = {
+        #     name: 'The Ronaldo Vampire Hunter Agency',
+        #     member: [
+        #       { name: 'Ronaldo' },
+        #       { name: 'Draluc' },
+        #       { name: 'John' }
+        #     ]
+        #   }
+        #   company = Company.new(data)
+        #   company.member[2].class #=> Company::Member
+        #
+        # == Options
+        #
+        # [:class_name]
+        #   Specify the name of the class to wrap. Use this if the name of the class
+        #   to wrap is not inferred from the nested field names.
+        def repeated(name, class_name: nil)
+          association_methods_module.define_method(name) do
+            klass = self.class.class_for(name, class_name)
+            get(name).map { |object| klass.new(object, parent: self) }
+          end
+        end
+
+        def class_for(name, class_name = nil)
+          return @classes[name] if @classes.key?(name)
+
+          basename = class_name || classify(name.to_s)
+          klass = if const_defined?(basename)
+                    const_get(basename)
+                  else
+                    const_set(basename, Class.new { include Model })
+                  end
+          klass.parent ||= self
+          @classes[name] = klass
+        end
+
+        private
+
+        def association_methods_module
+          @association_methods_module ||= begin
+            mod = Module.new
+            include mod
+            mod
+          end
+        end
+
+        def classify(key)
+          key.gsub(/([a-z\d]+)_?/) { |_| Regexp.last_match(1).capitalize }
+        end
+      end
+
+      module InstanceMethods # :nodoc:
+        private
+
+        def get(name)
+          self.class.adapter.get(object, name)
+        end
+      end
+    end
+  end
+end

data/lib/sumaki/model/attribute.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sumaki
+  module Model
+    # = Sumaki::Model::Attribute
+    module Attribute
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods # :nodoc:
+        # Access to the field.
+        #
+        #   class Anime
+        #     include Sumaki::Model
+        #     field :title
+        #     field :url
+        #   end
+        #
+        #   anime = Anime.new({ title: 'The Vampire Dies in No Time', url: 'https://sugushinu-anime.jp/' })
+        #   anime.title #=> 'The Vampire Dies in No Time'
+        #   anime.url #=> 'https://sugushinu-anime.jp/'
+        def field(name)
+          attribute_methods_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}       # def title
+              get(:'#{name}') #   get(:'title')
+            end               # end
+          RUBY
+        end
+
+        private
+
+        def attribute_methods_module
+          @attribute_methods_module ||= begin
+            mod = Module.new
+            include mod
+            mod
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sumaki/model/enum.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Sumaki
+  module Model
+    # = Sumaki::Model::Enum
+    module Enum
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      class EnumValue < Hash # :nodoc:
+        code = <<-RUBY
+          case value
+          when Symbol then super(value) || super(value.to_s)
+          when String then super(value) || super(value.to_sym)
+          else super(value)
+          end
+        RUBY
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1 # rubocop:disable Style/DocumentDynamicEvalDefinition
+          def key?(value); #{code}; end
+        RUBY
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1 # rubocop:disable Style/DocumentDynamicEvalDefinition
+          def key(value); #{code}; end
+        RUBY
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1 # rubocop:disable Style/DocumentDynamicEvalDefinition
+          def value?(value); #{code}; end
+        RUBY
+      end
+
+      module ClassMethods # :nodoc:
+        # Map a field to the specified value
+        #
+        #   class Character
+        #     include Sumaki::Model
+        #     field :name
+        #     enum :type, vampire: 1, vampire_hunter: 2, familier: 3, editor: 4
+        #   end
+        #
+        #   data = {
+        #     name: 'John',
+        #     type: 3
+        #   }
+        #
+        #   character = Character.new(data)
+        #   character.type #=> :familier
+        def enum(name, **values)
+          values = EnumValue[values]
+
+          enum_methods_module.define_method(name) do
+            value = get(name)
+
+            if values.key?(value)
+              value
+            elsif values.value?(value)
+              values.key(value)
+            end
+          end
+        end
+
+        private
+
+        def enum_methods_module
+          @enum_methods_module ||= begin
+            mod = Module.new
+            include mod
+            mod
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sumaki/model.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require_relative 'model/attribute'
+require_relative 'model/association'
+require_relative 'model/enum'
+
+module Sumaki
+  # = Sumaki
+  #
+  # Sumaki is a wrapper for structured data like JSON.
+  #
+  #   class AnimeList
+  #     include Sumaki::Model
+  #     repeated :anime
+  #     field :name
+  #
+  #    class Anime
+  #       include Sumaki::Model
+  #       singular :studio
+  #       field :title
+  #
+  #       class Studio
+  #         include Sumaki::Model
+  #         field :name
+  #       end
+  #     end
+  #   end
+  #
+  #   data = {
+  #     name: 'Winter 2023',
+  #     anime: [
+  #       {
+  #         title: 'The Vampire Dies in No Time',
+  #         studio: {
+  #           name: 'MADHOUSE Inc.'
+  #         }
+  #       },
+  #       {
+  #         title: '“Ippon” again!',
+  #         studio: {
+  #           name: 'BAKKEN RECORD'
+  #         }
+  #       }
+  #     ]
+  #   }
+  #
+  #   anime_list = AnimeList.new(data)
+  #   anime_list.name #=> 'Winter 2023'
+  #   anime_list.anime[0].title #=> 'The Vampire Dies in No Time'
+  #   anime_list.anime[0].studio.name #=>  'MADHOUSE Inc.'
+  #   anime_list.anime[0].object #=> { title: 'The Vampire Dies in No Time', studio: { name: 'MADHOUSE Inc.' } }
+  #
+  # == Access to fields
+  #
+  # By declaring `field`, you can access the field.
+  #
+  #   class Anime
+  #     include Sumaki::Model
+  #     field :title
+  #     field :url
+  #   end
+  #
+  #   anime = Anime.new({ title: "The Vampire Dies in No Time", url: "https://sugushinu-anime.jp/" })
+  #   anime.title #=> "The Vampire Dies in No Time"
+  #
+  # == Access to sub objects
+  #
+  # By declaring `singular`, you can access the sub object.
+  #
+  #   class Book
+  #     include Sumaki::Model
+  #     singular :company
+  #     field :title
+  #
+  #     class Company
+  #       include Sumaki::Model
+  #       field :name
+  #     end
+  #   end
+  #
+  #   data = {
+  #     title: "The Ronaldo Chronicles",
+  #     company: {
+  #       name: 'Autumn Books',
+  #     }
+  #   }
+  #
+  #   comic = Book.new(data)
+  #   comic.company.name #=> 'Autumn Books'
+  #
+  # By declaring `repeated`, you can access the repeated sub objects as an Array.
+  #
+  #   class Company
+  #     include Sumaki::Model
+  #     repeated :member
+  #     field :name
+  #
+  #     class Member
+  #       include Sumaki::Model
+  #       field :name
+  #     end
+  #   end
+  #
+  #   data = {
+  #     name: 'The Ronaldo Vampire Hunter Agency',
+  #     member: [
+  #       { name: 'Ronaldo' },
+  #       { name: 'Draluc' },
+  #       { name: 'John' }
+  #     ]
+  #   }
+  #
+  #   company = Company.new(data)
+  #   company.member.size #=> 3
+  #   company.member[2].name #=> 'John'
+  #
+  # == Access to the parent object
+  #
+  # Parent object can be referenced from sub object by `#parent` method.
+  #
+  #   class Character
+  #     include Sumaki::Model
+  #     singular :child
+  #     field :name
+  #
+  #     class Child
+  #       include Sumaki::Model
+  #       field :name
+  #     end
+  #   end
+  #
+  #   data = {
+  #     name: 'Draus',
+  #     child: {
+  #       name: 'Draluc'
+  #     }
+  #   }
+  #
+  #   character = Character.new(data)
+  #   character.child.name #=> 'Draluc'
+  #   character.child.parent.name #=> 'Draus'
+  #
+  # == Enumerations
+  #
+  # By declaring `enum`, You can map a field to a specified value.
+  #
+  #   class Character
+  #     include Sumaki::Model
+  #     field :name
+  #     enum :type, vampire: 1, vampire_hunter: 2, familier: 3, editor: 4
+  #   end
+  #
+  #   data = {
+  #     name: 'John',
+  #     type: 3
+  #   }
+  #
+  #   character = Character.new(data)
+  #   character.type #=> :familier
+  #
+  module Model
+    def self.included(base)
+      base.extend ClassMethods
+      base.include InstanceMethods
+
+      base.include Attribute
+      base.include Association
+      base.include Enum
+    end
+
+    module ClassMethods # :nodoc:
+      attr_writer :adapter
+      attr_accessor :parent
+
+      def adapter
+        @adapter || parent&.adapter || Config.default_adapter
+      end
+    end
+
+    module InstanceMethods # :nodoc:
+      attr_reader :object, :parent
+
+      def initialize(object, parent: nil)
+        @object = object
+        @parent = parent
+      end
+    end
+  end
+end

data/lib/sumaki/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sumaki
+  VERSION = '0.1.0'
+end

data/lib/sumaki.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'sumaki/version'
+require_relative 'sumaki/config'
+require_relative 'sumaki/adapter'
+require_relative 'sumaki/model'

data/sig/sumaki.rbs

@@ -0,0 +1,4 @@
+module Sumaki
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/sumaki.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sumaki/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sumaki'
+  spec.version = Sumaki::VERSION
+  spec.authors = ['Loose Coupling']
+  spec.email = ['loosecpl@gmail.com']
+
+  spec.summary = 'Sumaki is a wrapper for structured data like JSON.'
+  spec.description = <<~DESC
+    Sumaki is a wrapper for structured data like JSON.
+    Since Sumaki wraps the target data as it is, rather than parsing it using a schema, the original data can be referenced at any time.
+    This makes it easy to add or modify definitions as needed while checking the target data.
+    This feature may be useful when there is no document defining the structure of the data, or when the specification is complex and difficult to grasp, and the definition is written little by little starting from the obvious places.
+  DESC
+  spec.homepage = 'https://github.com/nowlinuxing/sumaki/'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: sumaki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Loose Coupling
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-19 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Sumaki is a wrapper for structured data like JSON.
+  Since Sumaki wraps the target data as it is, rather than parsing it using a schema, the original data can be referenced at any time.
+  This makes it easy to add or modify definitions as needed while checking the target data.
+  This feature may be useful when there is no document defining the structure of the data, or when the specification is complex and difficult to grasp, and the definition is written little by little starting from the obvious places.
+email:
+- loosecpl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sumaki.rb
+- lib/sumaki/adapter.rb
+- lib/sumaki/adapter/hash.rb
+- lib/sumaki/config.rb
+- lib/sumaki/model.rb
+- lib/sumaki/model/association.rb
+- lib/sumaki/model/attribute.rb
+- lib/sumaki/model/enum.rb
+- lib/sumaki/version.rb
+- sig/sumaki.rbs
+- sumaki.gemspec
+homepage: https://github.com/nowlinuxing/sumaki/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/nowlinuxing/sumaki/
+  source_code_uri: https://github.com/nowlinuxing/sumaki/
+  changelog_uri: https://github.com/nowlinuxing/sumaki/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Sumaki is a wrapper for structured data like JSON.
+test_files: []