taro 0.0.0 → 1.1.0

data/lib/taro/types/shared/rendering.rb

@@ -0,0 +1,22 @@
+# The `::render` method is intended for use in controllers.
+# Special types (e.g. PageType) may accept kwargs for `#coerce_response`.
+module Taro::Types::Shared::Rendering
+  def render(object, opts = {})
+    result = new(object).coerce_response(**opts)
+    self.last_render = [self, result.__id__]
+    result
+  end
+
+  def last_render=(info)
+    ActiveSupport::IsolatedExecutionState[:taro_last_render] = info
+  end
+
+  def last_render
+    ActiveSupport::IsolatedExecutionState[:taro_last_render]
+  end
+
+  # get the last used type for assertions in tests/specs
+  def used_in_response
+    last_render.to_a.first
+  end
+end

data/lib/taro/types/shared.rb

@@ -0,0 +1,3 @@
+module Taro::Types::Shared
+  Dir[File.join(__dir__, "shared", "*.rb")].each { |f| require f }
+end

data/lib/taro/types.rb

@@ -0,0 +1,3 @@
+module Taro::Types
+  Dir[File.join(__dir__, "types", "*.rb")].each { |f| require f }
+end

data/lib/taro/version.rb

@@ -1,5 +1,4 @@
-# frozen_string_literal: true
-
+# :nocov:
 module Taro
-  VERSION = "0.0.0"
+  VERSION = "1.1.0"
 end

data/lib/taro.rb

@@ -1,8 +1,3 @@
-# frozen_string_literal: true
-
-require_relative "taro/version"
-
 module Taro
-  class Error < StandardError; end
-  # Your code goes here...
+  Dir[File.join(__dir__, "taro", "*.rb")].each { |f| require f }
 end

data/tasks/benchmark.rake

@@ -0,0 +1,40 @@
+task :benchmark do
+  require 'benchmark/ips'
+  require 'json'
+  require_relative '../lib/taro'
+
+  data = JSON.load_file("#{__dir__}/benchmark_1kb.json", symbolize_names: true)
+
+  item_type = Class.new(Taro::Types::ObjectType) do
+    field :name, type: 'String', null: false
+    field :language, type: 'String', null: false
+    field :id, type: 'String', null: false
+    field :bio, type: 'String', null: false
+    field :version, type: 'Float', null: false
+  end
+
+  type = Taro::Types::ListType.for(item_type)
+
+  # 143.889k (± 2.7%) i/s -    723.816k in   5.034247s
+  Benchmark.ips do |x|
+    x.report('parse 1 KB of params') { type.new(data).coerce_input }
+  end
+
+  # 103.382k (± 6.5%) i/s -    522.550k in   5.087725s
+  Benchmark.ips do |x|
+    x.report('validate a 1 KB response') { type.new(data).coerce_response }
+  end
+
+  big_data = data * 1000
+  big_data.each { |el| el.merge('version' => rand) }
+
+  # 101.359 (± 5.9%) i/s -    513.000 in   5.078335s
+  Benchmark.ips do |x|
+    x.report('parse 1 MB of params') { type.new(big_data).coerce_input }
+  end
+
+  # 84.412 (± 2.4%) i/s -    427.000 in   5.061117s
+  Benchmark.ips do |x|
+    x.report('validate a 1 MB response') { type.new(big_data).coerce_response }
+  end
+end

data/tasks/benchmark_1kb.json

@@ -0,0 +1,23 @@
+[
+  {
+    "name": "Adeel Solangi",
+    "language": "Sindhi",
+    "id": "V59OF92YF627HFY0",
+    "bio": "Donec lobortis eleifend condimentum. Cras dictum dolor lacinia lectus vehicula rutrum. Maecenas quis nisi nunc. Nam tristique feugiat est vitae mollis. Maecenas quis nisi nunc.",
+    "version": 6.1
+  },
+  {
+    "name": "Afzal Ghaffar",
+    "language": "Sindhi",
+    "id": "ENTOCR13RSCLZ6KU",
+    "bio": "Aliquam sollicitudin ante ligula, eget malesuada nibh efficitur et. Pellentesque massa sem, scelerisque sit amet odio id, cursus tempor urna. Etiam congue dignissim volutpat. Vestibulum pharetra libero et velit gravida euismod.",
+    "version": 1.88
+  },
+  {
+    "name": "Aamir Solangi",
+    "language": "Sindhi",
+    "id": "IAKPO3R4761JDRVG",
+    "bio": "Vestibulum pharetra libero et velit gravida euismod. Quisque mauris ligula, efficitur porttitor sodales ac, lacinia non ex. Fusce eu ultrices elit, vel posuere neque.",
+    "version": 7.27
+  }
+]

metadata

@@ -1,31 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: taro
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-04 00:00:00.000000000 Z
-dependencies: []
-description: placeholder gem
+date: 2024-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This library provides an object-based type system for RESTful Ruby APIs,
+  with built-in parameter parsing, response rendering, and OpenAPI schema export.
 email:
 - janosch84@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/taro.rb
+- lib/taro/config.rb
+- lib/taro/errors.rb
+- lib/taro/export.rb
+- lib/taro/export/base.rb
+- lib/taro/export/open_api_v3.rb
+- lib/taro/rails.rb
+- lib/taro/rails/active_declarations.rb
+- lib/taro/rails/declaration.rb
+- lib/taro/rails/declaration_buffer.rb
+- lib/taro/rails/dsl.rb
+- lib/taro/rails/generators.rb
+- lib/taro/rails/generators/install_generator.rb
+- lib/taro/rails/generators/templates/enum_type.erb
+- lib/taro/rails/generators/templates/error_type.erb
+- lib/taro/rails/generators/templates/errors_type.erb
+- lib/taro/rails/generators/templates/input_type.erb
+- lib/taro/rails/generators/templates/no_content_type.erb
+- lib/taro/rails/generators/templates/object_type.erb
+- lib/taro/rails/generators/templates/scalar_type.erb
+- lib/taro/rails/normalized_route.rb
+- lib/taro/rails/param_parsing.rb
+- lib/taro/rails/railtie.rb
+- lib/taro/rails/response_validation.rb
+- lib/taro/rails/response_validator.rb
+- lib/taro/rails/route_finder.rb
+- lib/taro/rails/tasks/export.rake
+- lib/taro/types.rb
+- lib/taro/types/base_type.rb
+- lib/taro/types/coercion.rb
+- lib/taro/types/enum_type.rb
+- lib/taro/types/field.rb
+- lib/taro/types/field_validation.rb
+- lib/taro/types/input_type.rb
+- lib/taro/types/list_type.rb
+- lib/taro/types/object_type.rb
+- lib/taro/types/object_types/free_form_type.rb
+- lib/taro/types/object_types/no_content_type.rb
+- lib/taro/types/object_types/page_info_type.rb
+- lib/taro/types/object_types/page_type.rb
+- lib/taro/types/scalar/boolean_type.rb
+- lib/taro/types/scalar/float_type.rb
+- lib/taro/types/scalar/integer_type.rb
+- lib/taro/types/scalar/iso8601_date_type.rb
+- lib/taro/types/scalar/iso8601_datetime_type.rb
+- lib/taro/types/scalar/string_type.rb
+- lib/taro/types/scalar/timestamp_type.rb
+- lib/taro/types/scalar/uuid_v4_type.rb
+- lib/taro/types/scalar_type.rb
+- lib/taro/types/shared.rb
+- lib/taro/types/shared/additional_properties.rb
+- lib/taro/types/shared/custom_field_resolvers.rb
+- lib/taro/types/shared/derivable_types.rb
+- lib/taro/types/shared/description.rb
+- lib/taro/types/shared/errors.rb
+- lib/taro/types/shared/fields.rb
+- lib/taro/types/shared/item_type.rb
+- lib/taro/types/shared/object_coercion.rb
+- lib/taro/types/shared/openapi_name.rb
+- lib/taro/types/shared/openapi_type.rb
+- lib/taro/types/shared/rendering.rb
 - lib/taro/version.rb
-homepage:
+- tasks/benchmark.rake
+- tasks/benchmark_1kb.json
+homepage: https://github.com/taro-rb/taro
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/taro-rb/taro
+  source_code_uri: https://github.com/taro-rb/taro
+  changelog_uri: https://github.com/taro-rb/taro/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -44,5 +128,5 @@ requirements: []
 rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: placeholder gem
+summary: Typed Api using Ruby Objects.
 test_files: []