camille 0.5.13 → 0.5.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72196c6854c4c1354a55e5560b649753e49e23875a96d903b2d197dbae72581
-  data.tar.gz: 43b711376dfa6e9311245463738d999ffe73abc8fa9c7eb9516100f0f778c018
+  metadata.gz: 61a549590ebc8eaaa9c8962ff9aee4b2e61c38eddd90bb03c6744bf8ef08b645
+  data.tar.gz: 3e93ad48715beae1a358c7f25201e9ed1a286b058fc1f387815bef1362878fcc
 SHA512:
-  metadata.gz: 513b2edc45cf95615c6a0d6768a09b7a9ec40fdafb79756694db91b72ab7c614b49140ed6cd7e4cba1a0e8a033e39c5b50aec3ac20d8e5fac25f9ba169f958af
-  data.tar.gz: '077171197c9aaea4b898ebe5157333d72b2f78297ec08b84605cf9da3615543e24af37f21d06d0a501bb1aa077aa21972e77c1f7c28967fff9274702578a22e1'
+  metadata.gz: 86fcb85d6c7730071e3448f12121deec1d585e1d1f615087adbd73b23736282cb5a986bf97b51e8deda8c4862c836d34b5fa5bb3bec9108200d055d69b4ffa1e
+  data.tar.gz: 427928b9da7d5665bd0e0874682afb4228a3ad8ceef13887c873baaacc8ec1becc45604988318b992b00db79897d3bd4727281072165e5e5d03fdb927655362c

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.5.15
+
+### Added
+
+* Added key conversion cache
+
+### Changed
+
+* When generating TS, endpoints are now sorted by name
+
+## 0.5.14
+
+### Fixed
+
+* Fixed support for `render json: false`
+
 ## 0.5.13
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (0.5.12)
+    camille (0.5.14)
       rails (>= 6.1, < 8)
 
 GEM
@@ -75,11 +75,11 @@ GEM
     builder (3.2.4)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
-    date (3.3.3)
+    date (3.3.4)
     diff-lcs (1.5.0)
     erubi (1.12.0)
-    globalid (1.1.0)
-      activesupport (>= 5.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     loofah (2.19.1)
@@ -90,20 +90,20 @@ GEM
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.2)
+    marcel (1.0.4)
     method_source (1.0.0)
-    mini_mime (1.1.2)
+    mini_mime (1.1.5)
     minitest (5.17.0)
-    net-imap (0.3.4)
+    net-imap (0.4.16)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
-    net-protocol (0.2.1)
+    net-protocol (0.2.2)
       timeout
-    net-smtp (0.3.3)
+    net-smtp (0.5.0)
       net-protocol
-    nio4r (2.5.9)
+    nio4r (2.7.3)
     nokogiri (1.14.2-x86_64-linux)
       racc (~> 1.4)
     racc (1.6.2)
@@ -159,10 +159,10 @@ GEM
       rspec-support (~> 3.11)
     rspec-support (3.12.0)
     thor (1.2.1)
-    timeout (0.3.2)
+    timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.5)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     zeitwerk (2.6.7)

data/benchmarks/returning_multiple_values.rb

@@ -0,0 +1,94 @@
+require "benchmark/ips"
+
+def array_object
+  [1, 2, 3]
+end
+
+def hash_object
+  {
+    a: 1,
+    b: 2,
+    c: 3
+  }
+end
+
+class PlainObject
+  attr_reader :a, :b, :c
+
+  def initialize a, b, c
+    @a = a
+    @b = b
+    @c = c
+  end
+end
+
+def plain_object
+  PlainObject.new(1, 2, 3)
+end
+
+StructObject = Struct.new(:a, :b, :c)
+
+def struct_object
+  StructObject.new(1, 2, 3)
+end
+
+DataObject = Data.define(:a, :b, :c)
+
+def data_object
+  DataObject.new(1, 2, 3)
+end
+
+Benchmark.ips do |x|
+  x.report("parallel assignment") do
+    a, b, c = array_object
+  end
+
+  x.report("array access") do
+    arr = array_object
+    a = arr[0]
+    b = arr[1]
+    c = arr[2]
+  end
+
+  x.report("hash access") do
+    hsh = hash_object
+    a = hsh[:a]
+    b = hsh[:b]
+    c = hsh[:c]
+  end
+
+  x.report("hash destructuring") do
+    hash_object => {a:, b:, c:}
+  end
+
+  x.report("plain object") do
+    obj = plain_object
+    a = obj.a
+    b = obj.b
+    c = obj.c
+  end
+
+  x.report("struct object") do
+    obj = struct_object
+    a = obj.a
+    b = obj.b
+    c = obj.c
+  end
+
+  x.report("struct object destructuring") do
+    struct_object => {a:, b:, c:}
+  end
+
+  x.report("data object") do
+    obj = data_object
+    a = obj.a
+    b = obj.b
+    c = obj.c
+  end
+
+  x.report("data object destructuring") do
+    data_object => {a:, b:, c:}
+  end
+
+  x.compare!
+end

data/lib/camille/configuration.rb

@@ -2,21 +2,30 @@
 module Camille
   class Configuration
     class << self
-      def ts_header= string
-        @ts_header = string
-      end
+      attr_reader :response_key_converter, :params_key_converter
+      attr_accessor :ts_header, :ts_location
+
+      def load_default_configurations
+        self.response_key_converter = lambda do |symbol|
+          symbol.to_s.camelize(:lower)
+        end
 
-      def ts_header
-        @ts_header
+        self.params_key_converter = lambda do |string|
+          string.underscore
+        end
       end
 
-      def ts_location= string
-        @ts_location = string
+      def response_key_converter= lambda
+        @response_key_converter = lambda
+        Camille::Type.define_method :convert_response_key, &lambda
       end
 
-      def ts_location
-        @ts_location
+      def params_key_converter= lambda
+        @params_key_converter = lambda
+        Camille::Type.define_method :convert_params_key, &lambda
       end
+
+      Camille::Configuration.load_default_configurations
     end
   end
 end

data/lib/camille/controller.rb

@@ -17,7 +17,8 @@ module Camille
         render_options = args.last
         intended_status = render_options[:status] || 200
         if intended_status == 200 || intended_status == :ok
-          if value = render_options[:json]
+          if render_options.has_key? :json
+            value = render_options[:json]
             error, transformed = endpoint.response_type.transform_and_check(value)
             if error
               string_io = StringIO.new
@@ -25,7 +26,7 @@ module Camille
               raise TypeError.new("\nType check failed for response.\n#{string_io.string}")
             else
               if transformed.is_a? Hash
-                transformed.deep_transform_keys!{|k| k.to_s.camelize(:lower)}
+                transformed.deep_transform_keys!{|k| Camille::KeyConverter.convert_response_key(k)}
               end
               super(json: transformed)
             end
@@ -44,7 +45,7 @@ module Camille
       Camille::Loader.check_and_raise_exception
       if endpoint = camille_endpoint
         begin
-          params.deep_transform_keys!{|key| key.to_s.underscore}
+          params.deep_transform_keys!{|key| Camille::Configuration.params_key_converter.call(key.to_s)}
           result = super
           # When there's no `render` call, Rails will return status 204
           if response.status == 204

data/lib/camille/endpoint.rb

@@ -16,9 +16,9 @@ module Camille
         raise UnknownResponseError.new("Endpoint lacking a `response` definition.")
       end
       if @params_type
-        "#{ActiveSupport::Inflector.camelize @name, false}(params: #{@params_type.literal}): Promise<#{@response_type.literal}>"
+        "#{Camille::Configuration.response_key_converter.call(@name)}(params: #{@params_type.literal}): Promise<#{@response_type.literal}>"
       else
-        "#{ActiveSupport::Inflector.camelize @name, false}(): Promise<#{@response_type.literal}>"
+        "#{Camille::Configuration.response_key_converter.call(@name)}(): Promise<#{@response_type.literal}>"
       end
     end
 

data/lib/camille/key_converter.rb

@@ -0,0 +1,19 @@
+module Camille
+  class KeyConverter
+    class << self
+      RESPONSE_KEY_CACHE = {}
+
+      def convert_response_key key
+        if in_cache = RESPONSE_KEY_CACHE[key]
+          in_cache
+        else
+          RESPONSE_KEY_CACHE[key] = Camille::Configuration.response_key_converter.call(key)
+        end
+      end
+
+      def convert_params_key key
+        Camille::Configuration.params_key_converter.call(key)
+      end
+    end
+  end
+end

data/lib/camille/pick_and_omit.rb

@@ -30,7 +30,7 @@ module Camille
 
     private
       def keys_in_literal
-        @keys.map{|k| "\"#{k.to_s.camelize(:lower)}\""}.join(' | ')
+        @keys.map{|k| "\"#{Camille::Configuration.response_key_converter.call(k)}\""}.join(' | ')
       end
 
   end

data/lib/camille/schema.rb

@@ -17,7 +17,7 @@ module Camille
     def self.literal_lines
       [
         Camille::Line.new('{'),
-        *endpoints.map do |k, e|
+        *endpoints.sort_by{|k, e| k}.map do |k, e|
           Camille::Line.new("#{e.function},")
         end.map(&:do_indent),
         Camille::Line.new('}')

data/lib/camille/schemas.rb

@@ -31,13 +31,13 @@ module Camille
         tree.map do |key, value|
           if value.is_a? ::Hash
             [
-              Camille::Line.new("#{ActiveSupport::Inflector.camelize(key, false)}: {"),
+              Camille::Line.new("#{Camille::Configuration.response_key_converter.call(key)}: {"),
               tree_literal_lines(value).map(&:do_indent),
               Camille::Line.new('},')
             ]
           else
             value.literal_lines.tap do |lines|
-              lines.first.prepend("#{ActiveSupport::Inflector.camelize(key, false)}: ")
+              lines.first.prepend("#{Camille::Configuration.response_key_converter.call(key)}: ")
               lines.last.append(',')
             end
           end

data/lib/camille/types/object.rb

@@ -48,7 +48,7 @@ module Camille
       private
         def normalize_fields fields
           fields.map do |key, value|
-            check_case_conversion_safe key
+            check_key_conversion_safe key
             type = Camille::Type.instance(value)
             if key.end_with?('?')
               new_key = remove_question_mark(key)
@@ -65,13 +65,13 @@ module Camille
         end
 
         def literal_key key
-          "#{ActiveSupport::Inflector.camelize key.to_s, false}#{@optional_keys.include?(key) ? '?' : ''}"
+          "#{Camille::Configuration.response_key_converter.call(key)}#{@optional_keys.include?(key) ? '?' : ''}"
         end
 
-        def check_case_conversion_safe sym
+        def check_key_conversion_safe sym
           str = sym.to_s
-          if str != str.camelize.underscore
-            raise ArgumentError.new("Only keys satisfying `key.to_s == key.to_s.camelize.underscore` can be used.")
+          if str != Camille::Configuration.params_key_converter.call(Camille::Configuration.response_key_converter.call(str))
+            raise ArgumentError.new("Only keys satisfying `key == key.to_s.camelize.underscore` can be used.")
           end
         end
     end

data/lib/camille/version.rb

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

data/lib/camille.rb

@@ -37,6 +37,7 @@ require_relative "camille/loader"
 require_relative "camille/configuration"
 require_relative "camille/code_generator"
 require_relative "camille/main_controller"
+require_relative "camille/key_converter"
 
 require "rails/generators"
 require_relative "camille/generators/install_generator"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 0.5.13
+  version: 0.5.15
 platform: ruby
 authors:
 - Alyssa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-29 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +43,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- benchmarks/returning_multiple_values.rb
 - bin/console
 - bin/setup
 - gemfiles/rails-6.1
@@ -62,6 +63,7 @@ files:
 - lib/camille/generators/templates/schema_template.erb
 - lib/camille/generators/templates/type_template.erb
 - lib/camille/generators/type_generator.rb
+- lib/camille/key_converter.rb
 - lib/camille/line.rb
 - lib/camille/loader.rb
 - lib/camille/main_controller.rb
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Typed API schema for Rails with TypeScript codegen