roar-extensions 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in roar-extensions.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+  
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Donald Plummer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Roar::Extensions
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'roar-extensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roar-extensions
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+desc "Default: run specs."
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/lib/roar-extensions.rb

@@ -0,0 +1 @@
+require "roar_extensions"

data/lib/roar_extensions.rb

@@ -0,0 +1,30 @@
+require "roar_extensions/version"
+require "representable"
+require "representable/json"
+require "roar"
+require 'roar/representer/json'
+require 'roar/representer/json/hal'
+
+module RoarExtensions
+  def self.base_url=(url)
+    @base_url = url
+  end
+
+  def self.base_url
+    @base_url || raise("Set base url like RoarExtensions.base_url = 'http://example.com'")
+  end
+end
+
+require 'active_support'
+require 'active_support/core_ext/module'
+
+require 'roar_extensions/helpers/embedded_parameter_parsing'
+require 'roar_extensions/json_hal_extensions'
+require 'roar_extensions/representable_json_extensions'
+require 'roar_extensions/representer'
+require 'roar_extensions/presenter'
+require 'roar_extensions/destroyed_record_presenter'
+require 'roar_extensions/link_presenter'
+require 'roar_extensions/money_presenter'
+require 'roar_extensions/paginated_collection_presenter'
+require 'roar_extensions/resource_links'

data/lib/roar_extensions/destroyed_record_presenter.rb

@@ -0,0 +1,14 @@
+module RoarExtensions
+  module DestroyedRecordPresenter
+    def self.included(receiver)
+      receiver.send(:include, RoarExtensions::Presenter)
+
+      receiver.instance_eval do
+        property :id
+
+        alias_method :id, :record
+      end
+    end
+
+  end
+end

data/lib/roar_extensions/helpers/embedded_parameter_parsing.rb

@@ -0,0 +1,37 @@
+module RoarExtensions::Helpers
+  module EmbeddedParameterParsing
+
+    def self.included(base)
+      base.class_eval do
+        before_filter :parse_embedded_params_filter
+      end
+    end
+
+    def parse_embedded_params_filter
+      params[:embedded] = parse_embedded_params(params[:embedded])
+    end
+
+    def parse_embedded_params(embedded_str)
+      parse_embedded_params_list((embedded_str || '').split(','))
+    end
+
+  private
+    def parse_embedded_params_list(embedded)
+      with_children, without_children = embedded.map {|embed| embed.split(':', 2) }.
+                                                 each {|pair| pair[0] = pair[0].to_sym}.
+                                                 partition {|pair| pair.length > 1}
+
+      nested_embeds = with_children.inject({}) {|acc, (direct_embed, child)|
+                                                  acc[direct_embed] ||= []
+                                                  acc[direct_embed] << child
+                                                  acc
+                                               }.map do |(direct_embed, children)|
+                                                  [direct_embed, parse_embedded_params_list(children)]
+                                                end
+
+      without_children.flatten!
+      without_children << Hash[nested_embeds] unless nested_embeds.empty?
+      without_children
+    end
+  end
+end

data/lib/roar_extensions/json_hal_extensions.rb

@@ -0,0 +1,6 @@
+module Roar::Representer::JSON::HAL::Resources
+  def compile_fragment(bin, doc)
+    return super unless bin.definition.options[:embedded]
+    super(bin, doc["_embedded"] ||= {})
+  end
+end

data/lib/roar_extensions/link_presenter.rb

@@ -0,0 +1,26 @@
+class RoarExtensions::LinkPresenter
+  attr_reader :href, :rel, :title
+
+  def initialize(rel, href, title = nil)
+    @href  = href
+    @rel   = rel
+    @title = title
+  end
+
+  def ==(other)
+    href  == other.href && 
+    rel   == other.rel && 
+    title == other.title
+  end
+
+  def to_hash(*args)
+    {
+      rel => {
+        :href => href,
+        :title => title
+      }.delete_if {|k,v| v.nil? || v.empty?}
+    }
+  end
+
+  alias :as_json :to_hash
+end

data/lib/roar_extensions/money_presenter.rb

@@ -0,0 +1,13 @@
+class RoarExtensions::MoneyPresenter
+  include RoarExtensions::Presenter
+
+  root_element :money
+
+  delegated_property :cents
+  property :currency, :from => :currency_iso_code
+
+  private
+  def currency_iso_code
+    record.currency.iso_code
+  end
+end

data/lib/roar_extensions/paginated_collection_presenter.rb

@@ -0,0 +1,58 @@
+module RoarExtensions
+  class PaginatedCollectionPresenter
+    include RoarExtensions::Presenter
+
+    root_element :paginated_collection
+
+    delegated_property :per_page
+    delegated_property :total_pages
+    delegated_property :total_entries
+    delegated_property :current_page
+    delegated_property :next_page
+    delegated_property :previous_page
+
+    link(:rel => "self")          { page_link(record.current_page) }
+    link(:rel => "next_page")     { page_link(record.next_page) }
+    link(:rel => "previous_page") { page_link(record.previous_page) }
+
+    def initialize(record, base_path)
+      super(record)
+      @base_path = base_path
+    end
+
+    def page_link(page_number)
+      if page_number == 1
+        @base_path
+      elsif !page_number.nil?
+        "#{@base_path}?page=#{page_number}"
+      end
+    end
+
+    alias_method :to_hash_without_entries, :to_hash
+
+    # Hack to push the :include and :exclude options to the collection results
+    def to_hash(options = {})
+      opt_include = options.delete(:include)
+      opt_exclude = options.delete(:exclude)
+
+      res = to_hash_without_entries(options)
+      res["paginated_collection"]["entries"] = record.collect.map do |e|
+        entry_include = opt_include && opt_include.map {|name| get_actual_property_name(e, name)}
+        entry_exclude = opt_exclude && opt_exclude.map {|name| get_actual_property_name(e, name)}
+        e.to_hash(options.merge(:include => entry_include,
+                                :exclude => entry_exclude))
+      end
+      res
+    end
+
+  private
+    def get_actual_property_name(entry, aliased_name)
+      if attr = entry.send(:representable_attrs).
+                      detect {|a| a.options[:from].to_s == aliased_name.to_s}
+        attr.name
+      else
+        aliased_name
+      end
+    end
+  end
+end

data/lib/roar_extensions/presenter.rb

@@ -0,0 +1,65 @@
+require 'roar/representer/json'
+require 'roar/representer/json/hal'
+
+module RoarExtensions::Presenter
+
+  module ConditionalEmbeds
+    def skip_property?(bin, options)
+      if bin.definition.options[:embedded]
+        super || !embed_property?(bin.definition)
+      else
+        super
+      end
+    end
+
+    def embed_property?(definition)
+      (@embedded & [definition.name.to_sym, definition.from.to_sym]).present?
+    end
+  end
+
+  def initialize(record)
+    @record = record
+    @embedded ||= []
+  end
+
+  def self.included(base)
+    base.send(:include, Roar::Representer::JSON::HAL)
+    base.send(:include, ConditionalEmbeds)
+    base.extend(RoarExtensions::Representer)
+
+    base.class_eval do
+      alias :as_json :to_hash
+
+      def self.delegated_property(name, options = {})
+        if from = options.delete(:from)
+          define_method(name) do
+            record.send(from)
+          end
+        else
+          delegate name, :to => :record, :allow_nil => true
+        end
+
+        property name, options
+      end
+
+
+      def self.delegated_collection(name, options ={})
+        if from = options.delete(:from)
+          define_method(name) do
+            record.send(from)
+          end
+        else
+          delegate name, :to => :record, :allow_nil => true
+        end
+
+        collection name, options
+      end
+
+    end
+  end
+
+private
+  def record
+    @record
+  end
+end

data/lib/roar_extensions/representable_json_extensions.rb

@@ -0,0 +1,13 @@
+module Representable
+  module JSON
+    alias_method :to_hash_without_always_include_attributes, :to_hash
+
+    def to_hash(options = {})
+      if options[:include]
+        options[:include].map!(&:to_sym)
+        options[:include] |= self.class.always_include_attributes.map(&:to_sym)
+      end
+      to_hash_without_always_include_attributes(options)
+    end
+  end
+end

data/lib/roar_extensions/representer.rb

@@ -0,0 +1,61 @@
+module RoarExtensions::Representer
+  def root_element(element)
+    self.representation_wrap = element.to_s
+  end
+
+  def always_include_attributes
+    @always_include_attributes ||= []
+  end
+
+  # In the real API, :from and name are backwards?
+  def property(name, options = {})
+    options.merge!(:render_nil => true)
+
+    if options[:always_include]
+      always_include_attributes << name
+    end
+
+    if create_object = options.delete(:as)
+      define_method("#{name}_presented") do
+        attr_value = send(name)
+        attr_value && create_object.new(attr_value).as_json
+      end
+
+      options[:from] = "#{name}_presented"
+    end
+
+    if from = options.delete(:from)
+      super(from, options.merge(:from => name))
+    else
+      super(name, options)
+    end
+  end
+
+  def collection(name, options = {})
+    if create_object = options.delete(:as)
+      define_method("#{name}_presented") do
+        send(name).map do |element|
+          element && create_object.new(element).as_json
+        end
+      end
+      options[:from] = "#{name}_presented"
+    end
+
+    super name, options
+  end
+
+  def link(name, &block)
+    development = (defined?(Rails) && Rails.env.development?) ||
+                  ENV['RAILS_ENV']   == 'development' ||
+                  ENV['ENVIRONMENT'] == 'development'
+    if development
+      super(name) do
+        if path = instance_exec(&block)
+          "#{RoarExtensions.base_url}#{path}"
+        end
+      end
+    else
+      super
+    end
+  end
+end