Change dashed transform to dash

Author: remear

docs/general/configuration_options.md

@@ -36,14 +36,14 @@ Possible values:
 
 - `:camel` - ExampleKey
 - `:camel_lower` - exampleKey
-- `:dashed` - example-key
+- `:dash` - example-key
 - `:unaltered` - the original, unaltered key
 - `nil` - use the adapter default
 
 Each adapter has a default transform configured:
 
 - `Json` - `:unaltered`
-- `JsonApi` - `:dashed`
+- `JsonApi` - `:dash`
 
 `config.transform` is a global override of the adapter default. Adapters
 still prefer the render option `:transform` over this setting.

docs/general/transform.md

@@ -9,7 +9,7 @@ Provided transforms:
 
 - `:camel` - ExampleKey
 - `:camel_lower` - exampleKey
-- `:dashed` - example-key
+- `:dash` - example-key
 - `:unaltered` - the original, unaltered key
 - `nil` - use the adapter default
 
@@ -32,4 +32,4 @@ Key translation precedence is as follows:
 Each adapter has a default transform configured:
 
 - `Json` - `:unaltered`
-- `JsonApi` - `:dashed`
+- `JsonApi` - `:dash`

lib/active_model_serializers/adapter/json_api.rb

@@ -38,7 +38,7 @@ def initialize(serializer, options = {})
       end
 
       def self.default_transform
-        :dashed
+        :dash
       end
 
       # {http://jsonapi.org/format/#crud Requests are transactional, i.e. success or failure}

lib/active_model_serializers/transform.rb

@@ -4,7 +4,7 @@ module ActiveModelSerializers
   module Transform
     module_function
 
-    # Transforms keys to UpperCamelCase or PascalCase.
+    # Transforms values to UpperCamelCase or PascalCase.
     #
     # @example:
     #    "some_key" => "SomeKey",
@@ -18,7 +18,7 @@ def camel(value)
       end
     end
 
-    # Transforms keys to camelCase.
+    # Transforms values to camelCase.
     #
     # @example:
     #    "some_key" => "someKey",
@@ -32,16 +32,16 @@ def camel_lower(value)
       end
     end
 
-    # Transforms keys to dashed-case.
+    # Transforms values to dashed-case.
     # This is the default case for the JsonApi adapter.
     #
     # @example:
     #    "some_key" => "some-key",
     # @see {https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L185-L187 ActiveSupport::Inflector.dasherize}
-    def dashed(value)
+    def dash(value)
       case value
-      when Hash then value.deep_transform_keys! { |key| dashed(key) }
-      when Symbol then dashed(value.to_s).to_sym
+      when Hash then value.deep_transform_keys! { |key| dash(key) }
+      when Symbol then dash(value.to_s).to_sym
       when String then value.dasherize
       else value
       end
@@ -57,7 +57,7 @@ def underscore(hash)
       hash.deep_transform_keys! { |key| key.to_s.underscore.to_sym }
     end
 
-    # Returns the hash unaltered
+    # Returns the value unaltered
     def unaltered(value)
       value
     end

test/adapter/json/transform_test.rb

@@ -60,8 +60,8 @@ def test_transform_undefined
           end
         end
 
-        def test_transform_dashed
-          mock_request(:dashed)
+        def test_transform_dash
+          mock_request(:dash)
           assert_equal({
             blog: { id: 1, :"special-attribute" => 'neat', articles: nil }
           }, @adapter.serializable_hash(@options))

test/adapter/json_api/transform_test.rb

@@ -170,8 +170,8 @@ def test_success_doc_transform_serialization_ctx_overrides_global
           }, result)
         end
 
-        def test_success_document_transform_dashed
-          mock_request(:dashed)
+        def test_success_document_transform_dash
+          mock_request(:dash)
           serializer = PostSerializer.new(@post)
           adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
           result = adapter.serializable_hash(@options)
@@ -390,8 +390,8 @@ def test_error_document_transform_serialization_ctx_overrides_global
           assert_equal expected_errors_object, result
         end
 
-        def test_error_document_transform_dashed
-          mock_request(:dashed)
+        def test_error_document_transform_dash
+          mock_request(:dash)
 
           resource = ModelWithErrors.new
           resource.errors.add(:published_at, 'must be in the future')