roar-rails 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 959d27a6419a5834a092dede37f188173746d65c
-  data.tar.gz: eed0474a1b20ac29b46ac80d748c961ac77e6112
+  metadata.gz: e2c494afb7574bfff6fcd23e35e7a2748fe9a9e1
+  data.tar.gz: 1bac4790fcb074bda7d834c879707f909ca10a7f
 SHA512:
-  metadata.gz: 3120c16e48935d683aea818094fbcb0f65354fc923b7e08e4051ae8dcab2a7f2475b0af976e8830b18f610dd6c60028165f5ecbde12b6214919302cdc05e57f5
-  data.tar.gz: e6a4eec501b766ef532d1d91ee03e7441e1f085b0cbeeae6228730ba360a4df9fbb7b9198b844fa57fe411d161b4189960f931a275d0a25762ffdf79f052c574
+  metadata.gz: 3f10afc52cf7f202fde0e71fdabeda3eff795608ee5c494c955cbbb5f0b22aa2b1e08797c2e008fd4c91a7d07511c549e3ce44cd12b1ca958dc2cd7b42a79e58
+  data.tar.gz: f7ab0351b2e51a8d5d198f48e2e7c9ac77b3c0ce33803121b450890b073fa145b5487ec89d30a6fc6438ae5f90ee459ae7b9a7554357a969c23cd14547b5acb4

data/.gitignore

@@ -6,4 +6,5 @@ bin
 Gemfile*.lock
 pkg/*
 test/dummy/log/*
+test/dummy/tmp/*
 .rvmrc

data/CHANGES.markdown

@@ -1,3 +1,8 @@
+h2. 0.1.4
+
+* Added a generator to create modules from the command-line. Thanks to Guilherme Cavalcanti <guiocavalcanti> for working on this.
+* We always use `request.body.read` now, however, we call `rewind` beforehand.
+
 h2. 0.1.3
 
 * Fix a bug where `TestCase` wouldn't work in 3.2.

data/README.markdown

@@ -11,13 +11,44 @@ Roar is a framework for parsing and rendering REST documents. For a better overv
 * URL helpers in representers
 * Better tests
 * Autoloading
+* Generators
 
 This gem works with all Rails >= 3.x.
 
+
+## Generators
+
+The generator will create the representer modules in `app/representers` for you.
+
+Here's an example.
+
+```shell
+rails g representer Band id name
+```
+
+This will create the file `app/representers/band_representer.rb` with the following content,
+
+```ruby
+  module BandRepresenter
+    include Roar::Representer::JSON
+
+    property :id
+    property :name
+  end
+```
+
+You can change the format (e.g. XML), and pass arbitrary options to customize the generated representer. For all available options, just run
+
+```shell
+rails g representer
+```
+
+
 ## Rendering with #respond_with
 
 roar-rails provides a number of baked-in rendering methods.
 
+
 ### Conventional Rendering
 
 Easily render resources using representers with the built-in responder.
@@ -129,6 +160,7 @@ end
 
 In decorators' link blocks you currently have to use `represented` to get the actual represented model (this is `self` in module representers).
 
+
 ## Passing Options
 
 Both rendering and consuming support passing user options to the representer.

data/lib/generators/rails/USAGE

@@ -0,0 +1,42 @@
+Description:
+  Creates a new Representer and its properties.
+
+  This generates a representer module in app/representers directory.
+
+Examples:
+
+  rails g representer Band id name
+
+  This will create a representer as follows:
+
+  module BandRepresenter
+    include Roar::Representer::JSON
+
+    property :id
+    property :name
+  end
+
+  You can pass :class and :extend property options:
+
+    rails g singer id instrument:equipament:instrument_representer
+
+  This will add property options:
+
+    module SingerRepresenter
+      include Roar::Representer::JSON
+
+      property :id
+      property :instrument, :class => Equipament, :extend => InstrumentRepresenter
+    end
+
+  You can also choose representer format with --format option
+
+    rails g representer Band id name --format=xml
+
+  module BandRepresenter
+    include Roar::Representer::XML
+
+    property :id
+    property :name
+  end
+

data/lib/generators/rails/representer_generator.rb

@@ -0,0 +1,70 @@
+module Rails
+  module Generators
+    class RepresenterGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :properties, :type => :array, :default => [],
+        :banner => "property[:class[:extend]] property[:class[:extend]]"
+
+      class_option :format, :default => :json, :banner => "--format=JSON",
+        :desc => "Use different formats JSON, JSON::HAL or XML"
+
+      def generate_representer_file
+        template('representer.rb', file_path)
+      end
+
+      private
+
+      def format
+        options[:format].upcase
+      end
+
+      def property_options
+        PropertyBuilder.new(properties)
+      end
+
+      def file_path
+        base_path = 'app/representers'
+        File.join(base_path, class_path, "#{file_name}_representer.rb")
+      end
+
+      class PropertyBuilder
+        include Enumerable
+
+        def initialize(properties)
+          @raw = properties
+        end
+
+        def each(&block)
+          properties_with_options.each(&block)
+        end
+
+        private
+
+        def properties_with_options
+          properties.map do |(name, klass, representer)|
+            p = [name_option(name)]
+            p << hash_option(:class, klass)
+            p << hash_option(:extend, representer)
+
+            p.compact.join(', ')
+          end
+        end
+
+        def name_option(name)
+          return unless name
+          "property :#{name}"
+        end
+
+        def hash_option(key, value)
+          return unless key && value
+          ":#{key} => #{value.classify}"
+        end
+
+        def properties
+          @raw.map { |p| p.split(':') }
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/templates/representer.rb

@@ -0,0 +1,6 @@
+module <%= class_name %>Representer
+  include Roar::Representer::<%= format %>
+  <% property_options.each do |property| %>
+  <%= property -%>
+  <% end %>
+end

data/lib/roar/rails/controller_additions.rb

@@ -49,9 +49,7 @@ module Roar::Rails
 
     def incoming_string
       body = request.body
-
-      # this is my first respond_to? ever and i hate it (thanks, Rails :)
-      return body.string if body.respond_to?(:string)
+      body.rewind
       body.read
     end
 

data/lib/roar/rails/version.rb

@@ -1,5 +1,5 @@
 module Roar
   module Rails
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/test/consume_test.rb

@@ -72,17 +72,15 @@ class ConsumeWithOptionsOverridingConfigurationTest < ActionController::TestCase
 end
 
 class RequestBodyStringTest < ConsumeTest
-  test "allows Request instances supporting #string instead of #read" do
+  test "#read rewinds before reading" do
     @request.instance_eval do
       def body
-        Object.new.instance_eval do
-          def read;   "";                     end
-          def string; "{\"name\": \"Bumi\"}"; end # in rails 4, for whatever reasons, #read doesn't work as expected.
-
-          self
-        end
+        incoming = super
+        incoming.read
+        incoming
       end
     end
+
     post :consume_json, "{\"name\": \"Bumi\"}", :format => 'json'
     assert_equal %{#<struct Singer name="Bumi">}, @response.body
   end

data/test/representer_generator_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+require 'rails/generators'
+
+require 'generators/rails/representer_generator'
+
+class RepresentetGeneratorTest < Rails::Generators::TestCase
+  destination File.join(Rails.root, "tmp")
+  setup :prepare_destination
+  tests Rails::Generators::RepresenterGenerator
+
+  test "create a representer with correct class_name" do
+    run_generator %w(singer)
+
+    assert_file representer_path('singer'), /module SingerRepresenter/
+  end
+
+  test "create a representer with correct properties" do
+    run_generator %w(singer name id)
+
+    assert_file representer_path('singer'), /property :name/
+    assert_file representer_path('singer'), /property :id/
+  end
+
+  test "create a representer with default json support" do
+    run_generator %w(singer)
+
+    assert_file representer_path('singer'), /include Roar::Representer::JSON/
+  end
+
+  test "create a representer with different format support" do
+    run_generator %w(singer --format=XML)
+
+    assert_file representer_path('singer'), /include Roar::Representer::XML/
+  end
+
+  test "create a representer with property, class and exnted" do
+    run_generator %w(singer band:band:group_representer instrument:equipament:instrument_representer)
+
+    assert_file representer_path('singer'),
+      /property :band, :class => Band, :extend => GroupRepresenter/
+    assert_file representer_path('singer'),
+      /property :instrument, :class => Equipament, :extend => InstrumentRepresenter/
+  end
+
+  test "create a representer with property and class only" do
+    run_generator %w(singer band:band instrument:equipament)
+
+    assert_file representer_path('singer'),
+      /property :band, :class => Band/
+    assert_file representer_path('singer'),
+      /property :instrument, :class => Equipament/
+  end
+
+  def representer_path(name)
+    "app/representers/#{name}_representer.rb"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roar-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -167,6 +167,9 @@ files:
 - gemfiles/Gemfile.rails3-0
 - gemfiles/Gemfile.rails3-2
 - gemfiles/Gemfile.rails4-0
+- lib/generators/rails/USAGE
+- lib/generators/rails/representer_generator.rb
+- lib/generators/rails/templates/representer.rb
 - lib/roar-rails.rb
 - lib/roar/rails/controller_additions.rb
 - lib/roar/rails/hal.rb
@@ -218,10 +221,9 @@ files:
 - test/dummy/public/javascripts/rails.js
 - test/dummy/public/stylesheets/.gitkeep
 - test/dummy/script/rails
-- test/dummy/tmp/app/cells/blog/post/latest.html.erb
-- test/dummy/tmp/app/cells/blog/post_cell.rb
 - test/json_hal_renderer_test.rb
 - test/representer_computer_test.rb
+- test/representer_generator_test.rb
 - test/representer_test.rb
 - test/responder_test.rb
 - test/test_case_test.rb

data/test/dummy/tmp/app/cells/blog/post/latest.html.erb

@@ -1,7 +0,0 @@
-<h1>
-  Blog::Post#latest
-</h1>
-
-<p>
-  Find me in app/cells/blog/post/latest.html.erb
-</p>

data/test/dummy/tmp/app/cells/blog/post_cell.rb

@@ -1,7 +0,0 @@
-class Blog::PostCell < Cell::Rails
-
-  def latest
-    render
-  end
-
-end