cuprum-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc7e510f5f1c0b00c820bf755253cbe3d651a65aa946ee7468b8f7efd401b00
-  data.tar.gz: ed528cc1be9febe6f4f746ba2b1dc37a249b201c58c11cb4d2c1e7ea3086b9a1
+  metadata.gz: 1a11b779042715de20325d94601faa030c4c87222255feb97413f3394dbcd616
+  data.tar.gz: 7515ee3e188e48489b04e0cca7ac91a0f2a282a783a294ccdd10b920ae91c0d1
 SHA512:
-  metadata.gz: 2e39890f3051d9ab9e3c0c1a649cc1ac8fd7e9e0bb46c6be83981714abfa84c5612bbdec1ecd6dd7d4f07bc23b1cf61127fc0e01656e1474db9d824693b7498b
-  data.tar.gz: 5f02b6c267edfe148b5be0559e96cec1064bad5a873ab853ab2450fef92bca84800daa5212038d2c7cdc157ecf868ab0345a9cd1f70cf26d453e104d788870aa
+  metadata.gz: a1e000dc78e44d587c1185361c42f5cd75a151400dde79a963d3d779aeebadf1a8257727eccad0b5c15493be301f2687ad1ecd8705059043e53f0cd615b86637
+  data.tar.gz: dfde0bdb1c6a265c700412ef8174a62e1f3ccba3de7841c0da8af07069c987a05566eac98fe79b6dd20ae7b132c9d6e3ac8d607a89f11da16f9fc53a50db4a73

data/CHANGELOG.md

@@ -1,5 +1,150 @@
 # Changelog
 
+## O.2.0
+
+### Actions
+
+Implemented `#transaction` method.
+
+Refactored how actions handle required parameters.
+
+- The validation errors for the `Create` and `Update` actions are now scoped by the resource name. The error path should now match the relative path of the corresponding form field.
+
+- **(Breaking Change)** Action constructors no longer accept `:repository` or `:resource` keywords by default.
+
+- **(Breaking Change)** Actions now require a `:repository` keyword when called, and can accept arbitrary keywords.
+
+- **(Breaking Change)** Resource actions now require a `:resource` keyword when called.
+
+#### Middleware
+
+- Defined `Actions::Middleware::Associations::Find` for querying associations.
+- Defined `Actions::Middleware::Associations::Parent` for querying a parent `belongs_to` association.
+- Defines `Actions::Middleware::LogRequest` for logging request details.
+- Defines `Actions::Middleware::LogResult` for logging the action result.
+
+### Collections
+
+Implemented `Collection#qualified_path`, and added qualified path support to `Repository`.
+
+#### Commands
+
+Commands now handle invalid SQL statement exceptions by returning a failing result with a `StatementInvalid` error, rather than raising the exception.
+
+### Controllers
+
+Implemented `.build_request` class method.
+
+Implemented `.default_format` configuration option.
+
+Refactored `Cuprum::Rails::ControllerAction` to `Cuprum::Rails::Controllers::Action`.
+
+- **(Breaking Change)** Controller actions now require a `:controller` argument when called.
+
+#### Middleware
+
+Implemented controller middleware.
+
+- `Cuprum::Rails::Controllers::Middleware`.
+- `Cuprum::Rails::Controllers::ClassMethods::Middleware`.
+
+Updated `Cuprum::Rails::Controllers::Action` to apply configured middleware.
+
+#### Requests
+
+Added `#context` method to access the original request controller or context.
+
+Added `#member_action?` method to identify requests to resourceful member actions.
+
+Added `#native_session` method to lazily access the native controller session.
+
+Added `#properties` method to access all request properties as a Hash.
+
+Added `#path_params` method and properly handle parameters from the request path.
+
+**(Breaking Change)** Renamed `#method` property to `#http_method`.
+
+#### Resources
+
+Automatically generate a `Cuprum::Rails::Collection` when creating a resource with a `record_class` but no explicit `collection`.
+
+Added `#actions` option, which is automatically generated for singular and plural resources.
+
+Added `#parent` option and associated `#ancestors` and `#each_ancestors` methods.
+
+- **(Breaking Change)** Removed `Resource#collection`.
+
+#### Responders
+
+Implemented `Responders::Html::Resource` to handle both singular and plural resources.
+
+- `Cuprum::Rails::Responders::Html::PluralResource` is now deprecated.
+- `Cuprum::Rails::Responders::Html::SingularResource` is now deprecated.
+
+Updated `JsonResponder` to display full error messages in the development environment.
+
+Extracted `Responders::BaseResponder`.
+
+Extracted `Responders::Html::Rendering`.
+
+**(Breaking Change)** Responders now require `:controller` and `:request` parameters on initialization.
+
+#### Responses
+
+Implemented `Responses::HeadResponse`.
+
+Implemented `Responses::Html::RedirectBackResponse`.
+
+Added Rails flash message support to HTML responses:
+
+- `Responses::Html::RedirectBackResponse`.
+- `Responses::Html::RedirectResponse`.
+- `Responses::Html::RenderResponse`.
+
+### Results
+
+Implemented `Cuprum::Rails::Result`, which includes a `#metadata` property for passing contextual data such as an authentication session or page configuration.
+
+### Routes
+
+Route helpers not accept a wildcards hash for populating route wildcards, as an alternative to calling `routes.with_wildcards`.
+
+Member route methods now accept a primary key value as well as an entity, or allow the key to be passed as part of the wildcards.
+
+### RSpec
+
+Implemented contracts for Cuprum::Rails actions:
+
+- `Cuprum::Rails::RSpec::Contracts::Actions::CreateContracts`
+- `Cuprum::Rails::RSpec::Contracts::Actions::DestroyContracts`
+- `Cuprum::Rails::RSpec::Contracts::Actions::EditContracts`
+- `Cuprum::Rails::RSpec::Contracts::Actions::IndexContracts`
+- `Cuprum::Rails::RSpec::Contracts::Actions::NewContracts`
+- `Cuprum::Rails::RSpec::Contracts::Actions::ShowContracts`
+- `Cuprum::Rails::RSpec::Contracts::Actions::UpdateContracts`
+
+Contracts allow libraries or applications to verify their actions implement the action specifications.
+
+Defined `Cuprum::Rails::RSpec::Contracts::SerializersContracts`:
+
+- `ShouldSerailizeAttributesContract`: Verifies that the specified attributes are serialized with the expected values.
+
+Implemented `Cuprum::Rails::RSpec::Matchers::BeAResultMatcher`, which adds support for a `#metadata` property to the `be_a_result` matcher.
+
+- **(Breaking Change)** Existing contracts were moved into the `Cuprum::Rails::RSpec::Contracts` namespace and are scoped by type.
+  - `COMMAND_CONTRACT` is now `Contracts::CommandContracts::ShouldBeARailsCommandContract`.
+  - `DEFINE_ROUTE_CONTRACT` is replaced with `Contracts::RoutesContracts::ShouldDefineCollectionRouteContract` and `ShouldDefineMemberRouteContract`.
+
+### Serializers
+
+Implemented `Cuprum::Rails::Serializers::Context`.
+
+- Refactored serializers to take a `context:` keyword instead of `serializers:`.
+
+Implemented `Cuprum::Rails::Serializers::Json::PropertiesSerializer`.
+
+- Refactored `AttributesSerializer` to inherit from `PropertiesSerializer`. This is a breaking change for certain serializers with a block passed to `.attribute`.
+
 ## 0.1.0
 
 Initial version.

data/DEVELOPMENT.md

@@ -4,6 +4,26 @@
 
 - Remove ActionController::Parameters reference in Cuprum::Rails::Action.
 
+Test cases:
+
+- #create, #update (, #new ?) with generated attributes.
+- #edit, #new with related resources
+
+### Nested Resources
+
+Interactions are optional - opt-in? With a DSL?
+
+- With a required association (e.g. Chapter#book => /books/:book_id/chapters)
+  - All actions: require :book_id, valid Book entity, response 'book' => book
+- With a singular association (e.g. Book#author => /books)
+  - #index: response 'books' => mapped books
+  - #new, #edit: response 'books' => all books
+  - #create, #show, #update, #destroy: response 'book' => mapped book
+- With a plural association (e.g. Book#chapters)
+  - #create: create associated chapters, response 'chapters' => created chapters
+  - #show: response 'chapters' => mapped chapters
+  - #destroy: destroy associated chapters, response 'chapters' => destroyed chapters
+
 ## Controllers
 
 - Different cases for controllers.