camille 0.6.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99c0d1cc96b49d7fe7e6262f5a81f07feeb476bb0c1d3902259cdaf3d346497e
-  data.tar.gz: 1f9973ab623eb9d1322f116ba21eb1708bd5b32d8f3957798bfc87493bbaea1d
+  metadata.gz: a1ea493a56729858449f5d04a2242a0920a1aff7e345fde52d7fed3061b9cb3e
+  data.tar.gz: 624ef2a41e1c413e8e288de97f6b464f02ce51d9f2cda9eeed9b7ba4a818aaad
 SHA512:
-  metadata.gz: 50fb0dd0da2ca88ab75652af3bd8481ef37185dbfaddd5913cbfa4a9a24d0887cfe4fe1d7b42f98287bbcbce0fbbf108434343a1d149102f1471df16451a3556
-  data.tar.gz: f7d61181b15fa95ceff6e43f68148c3ca4bc03dbfbae89820250ce23028a78213fc255252b790e61890ff30a632c73442c1696c64372f1f56f9ecbf28d74928d
+  metadata.gz: 3bf2d9199a22c3a1a6f0c81538d93e87f4aacf073c52866fed0d07156f44af98d059c6559071554e275dc754bfd5413284acebf841e59f11659acfa9527827bc
+  data.tar.gz: 8b249d54deee18c77faebe8da95eda1ff6bae624daf67f9db1e54225951fca9259c5ef58f0c22393806ec5225c007f6962cdb377eff572a2bc20c97bb5c48859

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.0.0
+
+### Changed
+
+* **[BREAKING]** Removed `Camille::Type#test` in favour of `Camille::Type#check`.
+* Decimal and DateTime types are no longer generated for installation.
+
+## 0.6.4
+
+### Changed
+
+* **[BREAKING]** Calling `transform` before `check` is now each custom type's responsibility. To migrate, copy the `check` method [here](https://github.com/onyxblade/camille/commit/00fb254667480c3a2ce222209b09f7afd714fd5d#diff-94b933f5da6d8a5cfd11e24fd89c85cd8e788e4f25ca86a94bbf8aaabaade207R13) to existing custom types that make use of `transform`.
+* Warning comment is moved to config.ts_header.
+
 ## 0.6.3
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (0.6.2)
+    camille (0.6.4)
       rails (>= 6.1, < 8.1)
 
 GEM

data/README.md

@@ -29,10 +29,6 @@ Therefore, if the front-end requests the API by calling `data`, we have guarante
 
 By using these request functions, we also don't need to know about HTTP verbs and paths. It's impossible to have unrecognized routes, since Camille will make sure that each function handled by the correct Rails action.
 
-## Tutorial
-
-There's a step by step tutorial for setting up and showcasing Camille: https://github.com/onyxblade/camille-tutorial.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -128,14 +124,15 @@ Each custom type is considered a type alias in TypeScript. And `alias_of` define
 type Product = {id: number, name: string}
 ```
 
-You can perform a type check on a value using `test`, which might be handy in testing:
+You can perform a type check on a value using `check`, which can be handy in testing:
 
 ```ruby
-error = Camille::Types::Product.test(hash)
-if error.nil?
+# `check` will return either a Camille::Checked or a Camille::TypeError
+result = Camille::Types::Product.check(hash)
+if result.checked?
   # the hash is accepted by Camille::Types::Product type
 else
-  p error
+  p result
 end
 ```
 
@@ -161,7 +158,7 @@ params(
   # an array of objects also works
   object_array: {
     field: Number
-  }[]
+  }[],
   # a union type is two types connected by '|'
   union: Number | String,
   # an intersection type is two types connected by '&'
@@ -264,6 +261,10 @@ object:
 
 Everything in `config/camille/types` and `config/camille/schemas` will automatically reload after changes in development environment, just like other files in Rails.
 
+## Versioning
+
+This project uses [Semantic Versioning](https://semver.org/).
+
 ## Development
 
 Run tests with `bundle exec rake`.

data/lib/camille/basic_type.rb

@@ -41,10 +41,6 @@ module Camille
       raise NotImplementedError
     end
 
-    def transform value
-      value
-    end
-
     def self.| other
       Camille::Type.instance(self) | other
     end

data/lib/camille/code_generator.rb

@@ -4,7 +4,6 @@ module Camille
   module CodeGenerator
     def self.generate_ts
       io = StringIO.new
-      io.puts "// This file is automatically generated."
       io.puts Camille::Configuration.ts_header
       io.puts
       Camille::Types.literal_lines.each do |line|

data/lib/camille/generators/install_generator.rb

@@ -10,15 +10,14 @@ module Camille
         copy_file "configuration.rb", "config/camille/configuration.rb"
       end
 
-      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
         copy_file ".keep", "config/camille/schemas/.keep"
       end
 
+      def create_types_folder
+        copy_file ".keep", "config/camille/types/.keep"
+      end
+
     end
   end
 end

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

@@ -1,6 +1,7 @@
 Camille.configure do |config|
   # Contents to be placed at the beginning of the output TypeScript file.
   config.ts_header = <<~EOF
+    // DO NOT EDIT! This file is automatically generated.
     import request from './request'
   EOF
 end

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

@@ -9,4 +9,9 @@ class Camille::Types::DateTime < Camille::Type
   def transform value
     value.as_json
   end
+
+  def check value
+    normalized = transform value
+    super normalized
+  end
 end

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

@@ -13,4 +13,9 @@ class Camille::Types::Decimal < Camille::Type
       value
     end
   end
+
+  def check value
+    normalized = transform value
+    super normalized
+  end
 end

data/lib/camille/type.rb

@@ -20,17 +20,11 @@ module Camille
     end
 
     def check value
-      normalized = transform value
-      @underlying.check normalized
+      @underlying.check value
     end
 
-    def test value
-      result = check value
-      result.type_error? ? result : nil
-    end
-
-    def self.test value
-      new.test value
+    def self.check value
+      new.check value
     end
 
     def self.klass_name

data/lib/camille/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 1.0.0
 platform: ruby
 authors:
 - merely
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 2025-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails