mc_record 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45add1ffe0738ebb9f9d925f7e66a733fa80dfc52afd51f1b578383976f151c1
-  data.tar.gz: 3006284b78f0a555e562c95f8c1be07cc966148f714e8f096377eefa6774e0c7
+  metadata.gz: d1b447bc43a7b599ac54d932ce151a140f69d4d879c7c904193dde3c624d950d
+  data.tar.gz: 2e0f6429302e2155b6e975e23a064411b6f7e8c5be205925344a9643f5e05e4b
 SHA512:
-  metadata.gz: e89b677a6711cd704253ce9802958fd1b19c9522476d9cca6ba42dc6756ab6c4bcf6e431d2c74fb38d5798e871722c303ee75e311f68f76f35e39a0d2a815534
-  data.tar.gz: 95a932b56203ddfadebf6f03fbec2aba09ba2466a2834704d44cd605c044d9c847a656f1874c008fb4b8e452626ab3428efc0c6f1263fbef70c12cece97e0904
+  metadata.gz: e970106cc98568b244e2901231c5eb576702a8483dec2a96617733d7248bbff460debe874ebb46da367ddd88cf6d44aa4c0064a8d85d617a1b3e4d3a96056234
+  data.tar.gz: 35849a799e8c5f9e19c06f7746f53af2049653492930b1e8f0a10dfbb21bac30a290b67dd00d2f994541c0ea33789c0c643f224e527cd6bf22a80b1653164599

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "activesupport", "7.0.6"
 gem "microcms-ruby-sdk", "1.2.0"
 gem "rake", "~> 13.0"
+gem "steep"
+gem "typeprof"

data/Gemfile.lock

@@ -1,7 +1,10 @@
 PATH
   remote: .
   specs:
-    mc_record (0.1.0)
+    mc_record (0.1.1)
+      activesupport (= 7.0.6)
+      microcms-ruby-sdk (= 1.2.0)
+      rake (~> 13.0)
 
 GEM
   remote: https://rubygems.org/
@@ -11,14 +14,55 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    ast (2.4.2)
     concurrent-ruby (1.2.2)
+    csv (3.2.7)
+    ffi (1.15.5)
+    fileutils (1.7.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
     microcms-ruby-sdk (1.2.0)
     minitest (5.18.1)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (3.1.0)
+    securerandom (0.2.2)
+    steep (1.4.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.2.2)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.8.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    strscan (3.0.6)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    typeprof (0.21.7)
+      rbs (>= 1.8.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   x86_64-linux
@@ -28,6 +72,8 @@ DEPENDENCIES
   mc_record!
   microcms-ruby-sdk (= 1.2.0)
   rake (~> 13.0)
+  steep
+  typeprof
 
 BUNDLED WITH
    2.4.13

data/README.md

@@ -1,8 +1,63 @@
-TBD...
-
 # McRecord
+McRecord is an ORM for MicroCMS API like ActiveRecord written in Ruby.
+
+https://document.microcms.io/content-api/get-list-contents
+
+# Usage
+
+## Configure MicroCMS API
+
+Configure MicroCMS to use API.
+https://document.microcms.io/manual/create-api
 
 ## Installation
 
+Create a Gemfile like below, and `bundle install`.
+
+```ruby
+gem "mc_record"
+```
+
+## Implementation
+
+Create a Ruby source file like below.
+
+```ruby
+require "mc_record"
+
+# Credentials
+McRecord::Base.config(
+  service_domain: "[Domain Name]",
+  api_key: "[API Key]",
+  end_point: "[End Point]"
+)
+
+# Define a class that inherits `McRecord::Base`
+class Content < McRecord::Base
+end
+
+# Examples
+content = Content.find("[ID]") # => Content
+
+# MicroCMS API fields can be read/written as attributes of defined classes.
+puts content.name
+content.category = ""
+
+# Other Methods.
+Content.all # => Array<Content>
+Content.where(category: "[Name of Category]") # => Array<Content>
+```
+
+# Supported features
+
+
+The following methods are supported.
+
+- all
+- find
+- where
+
+# Future Issues.
 
-## Usage
+It looks like Active Record, but doesn't offer the complexities of Active Record::Relation.
+For example, it does not support method chaining, lazy loading, etc.

data/Steepfile

@@ -0,0 +1,26 @@
+# D = Steep::Diagnostic
+#
+target :lib do
+  signature "sig"
+  check "lib"                       # Directory name
+  check "Gemfile"                   # File name
+  library "ostruct"
+  # check "app/models/**/*.rb"        # Glob
+  # ignore "lib/templates/*.rb"
+  # library "pathname", "set"       # Standard libraries
+  # library "strong_json"           # Gems
+
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagFnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end

data/lib/mc_record/base.rb

@@ -32,7 +32,7 @@ module McRecord
 
     # @param [String]
     def self.find(id)
-      raise ".find is only support String parameter." unless id.instance_of?(String)
+      raise "wrong type of argument(expected String)" unless id.instance_of?(String)
 
       # OpenStruct
       api_result = MicroCMS.get(
@@ -52,6 +52,8 @@ module McRecord
 
     # @param [Hash]
     def self.where(arg)
+      raise ArgumentError, "wrong type of argument(expected Hash)" unless arg.instance_of?(Hash)
+
       param = build_filter_params(arg)
 
       raise "param not specified" if param == ""
@@ -64,6 +66,8 @@ module McRecord
 
     # @param [Hash]
     def self.where_not(arg)
+      raise ArgumentError, "wrong type of argument(expected Hash)" unless arg.instance_of?(Hash)
+
       param = build_not_filter_params(arg)
 
       raise "param not specified" if param == ""
@@ -182,10 +186,15 @@ module McRecord
       end
     end
 
+    private
+
+    # @param [String]
     def read_attribute(attr_name)
       @attributes.to_h[attr_name.to_sym]
     end
 
+    # @param attr_name [String]
+    # @param value [Object]
     def write_attribute(attr_name, value)
       @attributes[attr_name] = value
     end

data/lib/mc_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module McRecord
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/sig/mc_record.rbs

@@ -1,4 +1,29 @@
+# TypeProf 0.21.7
+
+# Classes
 module McRecord
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  class ContentNotFound < StandardError
+  end
+
+  class Base
+    extend ActiveSupport::Concern
+    @attributes: untyped
+    @@end_point: untyped
+
+    def initialize: (untyped attributes) -> void
+    def self.config: (service_domain: untyped, api_key: untyped, end_point: untyped) -> untyped
+    def self.all: -> Array[Base]
+    def self.find: (untyped id) -> Base
+    def self.where: (untyped arg) -> Array[Base]
+    def self.where_not: (untyped arg) -> Array[Base]
+    def self.define_method_attribute_if_needed: (untyped attr_name) -> nil
+    def self.build_filter_params: (untyped arg) -> untyped
+    def self.build_not_filter_params: (untyped arg) -> untyped
+    def self.open_structs_to_instances: (Array[untyped] contents) -> Array[Base]
+    def self.fetch_contents: (?nil param) -> Array[untyped]
+
+    private
+    def read_attribute: (untyped attr_name) -> untyped
+    def write_attribute: (untyped attr_name, untyped value) -> untyped
+  end
 end

data/sig/mc_record2.rbs

@@ -0,0 +1,29 @@
+# TypeProf 0.21.7
+
+# Classes
+module McRecord
+  class ContentNotFound < StandardError
+  end
+
+  class Base
+    extend ActiveSupport::Concern
+    @attributes: untyped
+    @@end_point: untyped
+
+    def initialize: (untyped attributes) -> void
+    def self.config: (service_domain: untyped, api_key: untyped, end_point: untyped) -> untyped
+    def self.all: -> Array[Base]
+    def self.find: (untyped id) -> Base
+    def self.where: (untyped arg) -> Array[Base]
+    def self.where_not: (untyped arg) -> Array[Base]
+    def self.define_method_attribute_if_needed: (untyped attr_name) -> nil
+    def self.build_filter_params: (untyped arg) -> untyped
+    def self.build_not_filter_params: (untyped arg) -> untyped
+    def self.open_structs_to_instances: (Array[untyped] contents) -> Array[Base]
+    def self.fetch_contents: (?nil param) -> Array[untyped]
+
+    private
+    def read_attribute: (untyped attr_name) -> untyped
+    def write_attribute: (untyped attr_name, untyped value) -> untyped
+  end
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: mc_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Akira Kure
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
-dependencies: []
+date: 2024-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.6
+- !ruby/object:Gem::Dependency
+  name: microcms-ruby-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: MicroCMS API's ORM like ActiveRecord for Ruby.
 email:
 - kuredev@gmail.com
@@ -23,11 +65,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- Steepfile
 - lib/mc_record.rb
 - lib/mc_record/base.rb
 - lib/mc_record/version.rb
-- mc_record.gemspec
 - sig/mc_record.rbs
+- sig/mc_record2.rbs
 homepage: https://github.com/kuredev/mc_record
 licenses: []
 metadata:

data/mc_record.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/mc_record/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "mc_record"
-  spec.version = McRecord::VERSION
-  spec.authors = ["Akira Kure"]
-  spec.email = ["kuredev@gmail.com"]
-
-  spec.summary = "MicroCMS API's ORM like ActiveRecord for Ruby."
-  spec.description = "MicroCMS API's ORM like ActiveRecord for Ruby."
-  spec.homepage = "https://github.com/kuredev/mc_record"
-  spec.required_ruby_version = ">= 2.6.0"
-
-#   spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/kuredev/mc_record"
-  spec.metadata["changelog_uri"] = "https://github.com/kuredev/mc_record"
-
-  # 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|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[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