camille 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d5aa31349909cebc62309be91631d632419b925d9a6ded594485dfa204e9170
-  data.tar.gz: d1b1cb24a630a0c109fc1042636372cf193dd135f1ef17784f3907c1a169502e
+  metadata.gz: 1c6d8ec2d346e2ff02811be47d900bee304a82f5a96e213cbf5e1c9f96f3fe61
+  data.tar.gz: 1a67d813067334b228caa09c9cc10411fa4a3b56eab57610b415c129616a4533
 SHA512:
-  metadata.gz: 7d65f32be6f7d8beee2d22b9d5cf5ed4fc84fa91c925605c6aa0be09d51475211ddbee5e23f321892d0f46fa59878af2d9753e3daac7c1e62f2ccf285e8147b6
-  data.tar.gz: f2195c3c54f6c571abeb2fa3b541160f734c1ecee6adfaec4bc4025ad0be820ae4235028a3c91427aec3c7cbdcc4ba19ba5f7a3e7cb530a3e943913b57955a78
+  metadata.gz: 0d977978049f5c5589731135c24c360145c3145d3ded0be2d158ea67546eece82d8af7c07674e1895d03a3071418adc9b1a6a597e5246b22b96d0c7abb2123d3
+  data.tar.gz: b4fd67e56fdd11db3c00d1e1ddee3a775c8e3d87ba2423cbe652729ed3dfb3460591d658a89bd1192385c45f0507fbeae5172a03acac65fcb3ad0880fe3b1aa7

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## 0.4.2
+
+### Added
+
+* Supported `transform` for custom types
+* Added default DateTime and Decimal type to install generator
+
+## 0.4.1
+
+### Added
+
+* Added utility types Pick and Omit
+
+### Fixed
+
+* Prevent loader errors from being silently rescued by Rails in development environment
+
+## 0.4.0
+
+The first stable release

data/Gemfile

@@ -9,5 +9,4 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "rails"
 gem "rspec-rails"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (0.4.0)
+    camille (0.4.2)
       rails (>= 6.1, < 8)
 
 GEM
@@ -172,7 +172,6 @@ PLATFORMS
 
 DEPENDENCIES
   camille!
-  rails
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-rails

data/README.md

@@ -2,7 +2,9 @@
 
 ## Why?
 
-Traditionally, the JSON response from a Rails API server isn't typed. So even if we have TypeScript at the front-end, we still have little guarantee that our back-end would return the correct type and structure of data. In order to eliminate type mismatch between both ends, Camille provides a syntax for you to define type schema for your Rails API, and uses these schemas to generate the TypeScript functions for calling the API.
+Traditionally, the JSON response from a Rails API server isn't typed. So even if we have TypeScript at the front-end, we still have little guarantee that our back-end would return the correct type and structure of data.
+
+In order to eliminate type mismatch between both ends, Camille provides a syntax for you to define type schema for your Rails API, and uses these schemas to generate the TypeScript functions for calling the API.
 
 For example, an endpoint defined in Ruby, where `data` is a controller action,
 
@@ -84,6 +86,8 @@ data(params: {id: number}): Promise<{name: string}>
 
 Therefore, the front-end user is required to provide an `id` when they call this function. And they can expect to get a `name` from the response of this request. There are no more type mismatch between both ends.
 
+The `params` type for an endpoint is required to be an object type, or a hash in Ruby, while `response` type can be any supported type, for example a `Boolean`.
+
 Camille will automatically add a Rails route for each endpoint. You don't need to do anything other than having the schema file in place.
 
 When defining an endpoint, you can also use `post` instead of `get` for non-idempotent requests. However, no other HTTP verbs are supported, because verbs in RESTful like `patch` and `delete` indicate what we do on resources, but in RPC-style design each request is merely a function call that does not concern RESTful resources.
@@ -153,12 +157,13 @@ params(
   number_literal: 1,
   string_literal: 'hello',
   # a custom type we defined above
-  product: Product
+  product: Product,
+  # Pick and Omit use [] to enclose parameters instead of <>
+  pick: Pick[{a: 1, b: 2}, 'a' | 'b'],
+  omit: Omit[Product, 'id']
 )
 ```
 
-String literal types and probably enums are planned for the future.
-
 ### TypeScript generation
 
 After you have your types and schemas in place, you can visit `/camille/endpoints.ts` in development environment to have the TypeScript request functions generated.
@@ -235,6 +240,10 @@ object:
     [2]: Expected number, got "3".
 ```
 
+### Reloading
+
+Everything in `config/camille/types` and `config/camille/schemas` will automatically reload after changes in development environment, just like other files in Rails.
+
 ## Development
 
 Run tests with `bundle exec rake`.

data/gemfiles/rails-6.1

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rspec-rails"
+
+gem 'rails', '~> 6.1.0'

data/gemfiles/rails-7.0

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rspec-rails"
+
+gem 'rails', '~> 7.0.0'

data/lib/camille/basic_type.rb

@@ -11,6 +11,15 @@ module Camille
       Camille::Types::Array.new(self)
     end
 
+    def transform_and_check value
+      transformed = transform value
+      [check(value), transformed]
+    end
+
+    def transform value
+      value
+    end
+
     def self.| other
       Camille::Type.instance(self) | other
     end

data/lib/camille/controller_extension.rb

@@ -15,16 +15,16 @@ module Camille
       if endpoint = camille_endpoint
         render_options = args.last
         if value = render_options[:json]
-          error = endpoint.response_type.check(value)
+          error, transformed = endpoint.response_type.transform_and_check(value)
           if error
             string_io = StringIO.new
             Camille::TypeErrorPrinter.new(error).print(string_io)
             raise TypeError.new("\nType check failed for response.\n#{string_io.string}")
           else
-            if value.is_a? Hash
-              value.deep_transform_keys!{|k| k.to_s.camelize(:lower)}
+            if transformed.is_a? Hash
+              transformed.deep_transform_keys!{|k| k.to_s.camelize(:lower)}
             end
-            super(json: value)
+            super(json: transformed)
           end
         else
           raise ArgumentError.new("Expected key :json for `render` call.")
@@ -35,6 +35,7 @@ module Camille
     end
 
     def process_action(*)
+      Camille::Loader.check_and_raise_exception
       if endpoint = camille_endpoint
         params.deep_transform_keys!{|key| key.to_s.underscore}
         super

data/lib/camille/custom_types/date.rb

@@ -0,0 +1,31 @@
+require 'date'
+
+# This type is only for testing, to simulate the usage of transform.
+module Camille
+  module CustomTypes
+    class Date < Camille::Type
+      include Camille::Types
+
+      alias_of(
+        type: 'Date',
+        value: Number
+      )
+
+      def transform value
+        case value
+        when ::Date
+          timestamp = value.to_time.to_i
+        when ::Time
+          timestamp = value.to_i
+        end
+        {
+          type: 'Date',
+          value: timestamp.to_i * 1000
+        }
+      end
+
+    end
+  end
+end
+
+Camille::Loader.loaded_types.delete(Camille::CustomTypes::Date)

data/lib/camille/generators/install_generator.rb

@@ -10,8 +10,9 @@ module Camille
         copy_file "configuration.rb", "config/camille/configuration.rb"
       end
 
-      def create_types_folder
-        copy_file ".keep", "config/camille/types/.keep"
+      def create_date_time_and_decimal
+        copy_file "date_time.rb", "config/camille/types/date_time.rb"
+        copy_file "decimal.rb", "config/camille/types/decimal.rb"
       end
 
       def create_schemas_folder

data/lib/camille/generators/templates/date_time.rb

@@ -0,0 +1,12 @@
+using Camille::Syntax
+
+class Camille::Types::DateTime < Camille::Type
+  include Camille::Types
+
+  alias_of(String)
+
+  # transforms a DateTime into a String of ISO 8601 format
+  def transform value
+    value.as_json
+  end
+end

data/lib/camille/generators/templates/decimal.rb

@@ -0,0 +1,16 @@
+using Camille::Syntax
+
+class Camille::Types::Decimal < Camille::Type
+  include Camille::Types
+
+  alias_of(Number)
+
+  # transforms a BigDecimal into a Float so it fits in Number type
+  def transform value
+    if value.is_a? BigDecimal
+      value.to_f
+    else
+      value
+    end
+  end
+end

data/lib/camille/loader.rb

@@ -41,11 +41,23 @@ module Camille
 
       def reload_types_and_schemas
         synchronize do
-          Camille::Loader.loaded_types.clear
-          Camille::Loader.loaded_schemas.clear
-          @zeitwerk_loader.reload
-          eager_load
-          construct_controller_name_to_schema_map
+          begin
+            @exception = nil
+            Camille::Loader.loaded_types.clear
+            Camille::Loader.loaded_schemas.clear
+            @zeitwerk_loader.reload
+            eager_load
+            construct_controller_name_to_schema_map
+          rescue Exception => e
+            @exception = e
+            raise e
+          end
+        end
+      end
+
+      def check_and_raise_exception
+        if @exception
+          raise @exception
         end
       end
 

data/lib/camille/main_controller.rb

@@ -3,6 +3,7 @@ require 'action_controller'
 module Camille
   class MainController < ActionController::Base
     def endpoints_ts
+      Camille::Loader.check_and_raise_exception
       render plain: Camille::CodeGenerator.generate_ts
     end
   end

data/lib/camille/pick_and_omit.rb

@@ -0,0 +1,51 @@
+module Camille
+  # shared base class for Pick and Omit
+  class PickAndOmit < Camille::BasicType
+    class ArgumentError < ::ArgumentError; end
+
+    def initialize type, keys
+      @type = Camille::Type.instance(type)
+      case
+      when @type.is_a?(Camille::Types::Object)
+        @target_object = @type
+      when @type.is_a?(Camille::Type) && @type.underlying.is_a?(Camille::Types::Object)
+        @target_object = @type.underlying
+      else
+        raise ArgumentError.new("Currently onle an object type or an alias of object type is supported in #{klass_name}. Got #{type.inspect}.")
+      end
+
+      @keys = Camille::Type.instance(keys)
+      case
+      when @keys.is_a?(Camille::Types::StringLiteral)
+        @keys_array = [@keys.value].map(&:to_sym)
+      when @keys.is_a?(Camille::Types::Union)
+        unfolded = unfold_union(@keys).flatten
+        if unfolded.all?{|x| x.is_a?(Camille::Types::StringLiteral)}
+          @keys_array = unfolded.map(&:value).map(&:to_sym)
+        else
+          raise ArgumentError.new("The second argument of #{klass_name} has to be a string literal or an union of string literals. Got #{keys.inspect}.")
+        end
+      else
+        raise ArgumentError.new("The second argument of #{klass_name} has to be a string literal or an union of string literals. Got #{keys.inspect}.")
+      end
+    end
+
+    def literal
+      "#{klass_name}<#{@type.literal}, #{@keys.literal}>"
+    end
+
+    def self.[] type, keys
+      self.new type, keys
+    end
+
+    private
+      def unfold_union type
+        if type.is_a?(Camille::Types::Union)
+          [unfold_union(type.left), unfold_union(type.right)]
+        else
+          [type]
+        end
+      end
+
+  end
+end

data/lib/camille/type.rb

@@ -21,6 +21,11 @@ module Camille
       @underlying.check value
     end
 
+    def transform_and_check value
+      transformed = transform value
+      @underlying.transform_and_check transformed
+    end
+
     def self.klass_name
       name.gsub(/^Camille::Types::/, '')
     end

data/lib/camille/types/array.rb

@@ -18,6 +18,11 @@ module Camille
         end
       end
 
+      def transform_and_check value
+        transformed = value.map{|x| @content.transform x}
+        [check(transformed), transformed]
+      end
+
       def literal
         "#{@content.literal}[]"
       end

data/lib/camille/types/number_literal.rb

@@ -3,6 +3,8 @@ module Camille
     class NumberLiteral < Camille::BasicType
       class ArgumentError < ::ArgumentError; end
 
+      attr_reader :value
+
       def initialize value
         if value.is_a?(Integer) || value.is_a?(Float)
           @value = value

data/lib/camille/types/object.rb

@@ -21,6 +21,29 @@ module Camille
         end
       end
 
+      def transform_and_check value
+        if value.is_a? Hash
+          transform_and_check_results = @fields.map do |key, type|
+            [key, type.transform_and_check(value[key])]
+          end
+
+          errors = transform_and_check_results.map do |key, (error, transformed)|
+            [key.to_s, error]
+          end.select{|x| x[1]}
+
+          if errors.empty?
+            transformed = transform_and_check_results.map do |key, (error, transformed)|
+              [key, transformed]
+            end.to_h
+            [nil, transformed]
+          else
+            Camille::TypeError.new(**errors.to_h)
+          end
+        else
+          Camille::TypeError.new("Expected hash, got #{value.inspect}.")
+        end
+      end
+
       def literal
         "{#{@fields.map{|k,v| "#{ActiveSupport::Inflector.camelize k.to_s, false}: #{v.literal}"}.join(', ')}}"
       end

data/lib/camille/types/omit.rb

@@ -0,0 +1,24 @@
+module Camille
+  module Types
+    class Omit < PickAndOmit
+      def check value
+        processed_object.check(value)
+      end
+
+      def transform_and_check value
+        processed_object.transform_and_check(value)
+      end
+
+      private
+        def klass_name
+          'Omit'
+        end
+
+        def processed_object
+          fields = @target_object.fields.reject{|k, _| @keys_array.include?(k)}
+          Camille::Types::Object.new(fields)
+        end
+
+    end
+  end
+end

data/lib/camille/types/pick.rb

@@ -0,0 +1,24 @@
+module Camille
+  module Types
+    class Pick < PickAndOmit
+      def check value
+        processed_object.check(value)
+      end
+
+      def transform_and_check value
+        processed_object.transform_and_check(value)
+      end
+
+      private
+        def klass_name
+          'Pick'
+        end
+
+        def processed_object
+          fields = @target_object.fields.select{|k, _| @keys_array.include?(k)}
+          Camille::Types::Object.new(fields)
+        end
+
+    end
+  end
+end

data/lib/camille/types/string_literal.rb

@@ -3,6 +3,8 @@ module Camille
     class StringLiteral < Camille::BasicType
       class ArgumentError < ::ArgumentError; end
 
+      attr_reader :value
+
       def initialize value
         if value.is_a?(::String)
           @value = value

data/lib/camille/types/union.rb

@@ -21,6 +21,26 @@ module Camille
         end
       end
 
+      def transform_and_check value
+        left_transformed = @left.transform value
+        left_result = @left.check left_transformed
+        if left_result
+          right_transformed = @right.transform value
+          right_result = @right.check right_transformed
+          if right_result
+            error = Camille::TypeError.new(
+              'union.left' => left_result,
+              'union.right' => right_result
+            )
+            [error, nil]
+          else
+            [nil, right_transformed]
+          end
+        else
+          [nil, left_transformed]
+        end
+      end
+
       def literal
         "#{@left.literal} | #{@right.literal}"
       end

data/lib/camille/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Camille
-  VERSION = "0.4.0"
+  VERSION = "0.4.2"
 end

data/lib/camille.rb

@@ -17,6 +17,9 @@ require_relative "camille/types/tuple"
 require_relative "camille/types/any"
 require_relative "camille/types/number_literal"
 require_relative "camille/types/string_literal"
+require_relative "camille/pick_and_omit"
+require_relative "camille/types/pick"
+require_relative "camille/types/omit"
 require_relative "camille/type"
 require_relative "camille/type_error"
 require_relative "camille/type_error_printer"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - 辻彩
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,28 +38,35 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/rails-6.1
+- gemfiles/rails-7.0
 - lib/camille.rb
 - lib/camille/basic_type.rb
 - lib/camille/code_generator.rb
 - lib/camille/configuration.rb
 - lib/camille/controller_extension.rb
+- lib/camille/custom_types/date.rb
 - lib/camille/endpoint.rb
 - lib/camille/generators/install_generator.rb
 - lib/camille/generators/schema_generator.rb
 - lib/camille/generators/templates/.keep
 - lib/camille/generators/templates/configuration.rb
+- lib/camille/generators/templates/date_time.rb
+- lib/camille/generators/templates/decimal.rb
 - lib/camille/generators/templates/schema_template.erb
 - lib/camille/generators/templates/type_template.erb
 - lib/camille/generators/type_generator.rb
 - lib/camille/line.rb
 - lib/camille/loader.rb
 - lib/camille/main_controller.rb
+- lib/camille/pick_and_omit.rb
 - lib/camille/railtie.rb
 - lib/camille/schema.rb
 - lib/camille/schemas.rb
@@ -75,6 +82,8 @@ files:
 - lib/camille/types/number.rb
 - lib/camille/types/number_literal.rb
 - lib/camille/types/object.rb
+- lib/camille/types/omit.rb
+- lib/camille/types/pick.rb
 - lib/camille/types/string.rb
 - lib/camille/types/string_literal.rb
 - lib/camille/types/tuple.rb