halibut-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: 63e4447a232f1f4504003fca37003087ee3478927a83fc43e07d5b308c9495d8007d699c6bc7794946bac44ee6b59623a4b5892bbf567dbe22c43dd747d3489a
+  data.tar.gz: f54e3b4af0386c368b52fcdce4a7c6024921f97e21c5a44956ee184b721b0b7b71aea4e04de3d1ae6eb1f07b47571e530d546bf4f917fd14ecde7f071a213ab3
+SHA1: 
+  metadata.gz: be74758fe5a0aec238d93526f64b12b2d733edad
+  data.tar.gz: 11f3141ddebba2e062a63d5faed937bd82211133

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Toru KAWAMURA
+
+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,104 @@
+# Halibut::Rails
+
+Rails Template Handler for [Halibut](https://github.com/locks/halibut) Builder.
+
+Useful to make [HAL](http://stateless.co/hal_specification.html) JSON responses in Rails such as Web APIs.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'halibut-rails'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+You can write Halibut Builder syntax in view template.
+
+Template file is recognized by extension `.halibut`.
+
+*Notice:* You don't need `Halibut::Builder.new`. Instead, use `link 'self'` for indicating self path.
+
+```ruby
+# app/views/orders/index.json.halibut
+property 'currentlyProcessing', 14
+property 'shippedToday', 20
+property 'total', @orders.size
+
+namespace 'th', 'http://things-db.com/{rel}'
+
+link 'self', orders_path(page: @orders.current_page)
+link 'find', '/orders{?q}', templated: true
+link 'next', orders_path(page: @orders.next_page) unless @orders.last_page?
+link 'prev', orders_path(page: @orders.prev_page) unless @orders.first_page?
+
+@orders.each do |order|
+  resource 'orders', order_path(order) do
+    property 'total', order.total
+    property 'currency', order.currency
+    property 'status', order.status
+    link 'th:customer', customer_path(order.customer)
+  end
+end
+```
+
+This will build the following structure:
+
+```json
+{
+  "currentlyProcessing": 14,
+  "shippedToday": 20,
+  "total": 35,
+  "_links": {
+    "self": { "href": "/orders" },
+    "find": { "href": "/orders{?q}", "templated": true },
+    "next": { "href": "/orders?page=2" },
+    "curie": {
+      "href": "http://things-db.com/{rel}",
+      "templated": true,
+      "name": "th"
+    }
+  },
+  "_embedded": {
+    "orders": [
+      {
+        "total": 30.00,
+        "currency": "USD",
+        "status": "shipped",
+        "_links": {
+          "self": { "href": "/orders/123" },
+          "th:customer": { "href": "/customers/7809" }
+        },
+      },
+      {
+        "total": 20.00,
+        "currency": "USD",
+        "status": "processing",
+        "_links": {
+          "self": { "href": "/orders/124" },
+          "th:customer": { "href": "/customers/12369" }
+        }
+      }
+    ]
+  }
+}
+```
+
+As the example above, you can use instance variables and helpers ordinarily.
+
+## Restriction
+
+`relation` notation is not supported yet.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/halibut-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/halibut-rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'halibut/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'halibut-rails'
+  spec.version       = Halibut::Rails::VERSION
+  spec.authors       = ['Toru KAWAMURA']
+  spec.email         = ['tkawa@4bit.net']
+  spec.summary       = %q{Rails Template Handler for Halibut Builder}
+  spec.description   = %q{Rails Template Handler for Halibut Builder}
+  spec.homepage      = 'https://github.com/tkawa/halibut-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'halibut'
+  spec.add_dependency 'rails'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

data/lib/halibut/rails.rb

@@ -0,0 +1,5 @@
+require 'halibut'
+require 'halibut/rails/railtie'
+require 'halibut/rails/context'
+require 'halibut/rails/context_delegator'
+require 'halibut/rails/version'

data/lib/halibut/rails/builder_handler.rb

@@ -0,0 +1,10 @@
+module Halibut
+  module Rails
+    class BuilderHandler
+      def self.call(template)
+        %{Halibut::Rails::ContextDelegator.around(self){ #{template.source} } }
+      end
+    end
+  end
+end
+ActionView::Template.register_template_handler :halibut, Halibut::Rails::BuilderHandler

data/lib/halibut/rails/context.rb

@@ -0,0 +1,50 @@
+module Halibut
+  module Rails
+    class Context < Halibut::Builder::RootContext
+      def initialize(view_context, options = {})
+        @view_context = view_context
+        @resource = Halibut::Core::Resource.new(options[:href])
+      end
+
+      def _resource
+        @resource
+      end
+
+      # Adds an embedded resource.
+      #
+      # @param [String] rel  Embedded resource relation to the parent resource
+      # @param [String] href URI to the resource itself
+      # @param [Proc]   blk  Instructions to construct the embedded resource
+      def resource(rel, href=nil, &embedded_definition)
+        embedded = self.class.new(@view_context, href: href)
+        @view_context._swap_context(embedded, &embedded_definition) if block_given?
+        @resource.embed_resource(rel, embedded._resource)
+      end
+
+      # Adds links or resources to a relation.
+      #
+      # Relation allows the user to specify links, or resources, per relation,
+      # instead of individually.
+      # This feature was introduced as an attempt to reduce repeating the
+      # relation per link/resource, and thus reducing typos.
+      #
+      #     resource = Halibut::Builder.new do
+      #       relation :john do
+      #         link 'http://appleseed.com/john'
+      #       end
+      #     end.resource
+      #     resource.links[:john].first.href
+      #
+      # @param [String,Symbol] rel
+      # @param [Proc]          blk Instructions to be executed in the relation
+      #                            context
+      def relation(rel, &relation_definition)
+        raise NotImplementedError, 'relation is not supported yet'
+      end
+    end
+
+    # RelationContext is not supported yet
+    # class RelationContext < Halibut::Builder::RelationContext
+    # end
+  end
+end

data/lib/halibut/rails/context_delegator.rb

@@ -0,0 +1,47 @@
+module Halibut
+  module Rails
+    module ContextDelegator
+      attr_reader :_halibut_context
+
+      def self.setup(view_context)
+        view_context.extend(self)
+        view_context._setup_delegation!(Halibut::Rails::Context.new(view_context))
+      end
+
+      def self.teardown(view_context)
+        # if @options[:pretty]
+          JSON.pretty_generate(view_context._halibut_resource.to_hash)
+        # else
+        #   Halibut::Adapter::JSON.dump(context._halibut_resource)
+        # end
+      end
+
+      def self.around(view_context)
+        setup(view_context)
+        yield
+        teardown(view_context)
+      end
+
+      def self.extended(obj)
+        obj.extend(SingleForwardable)
+      end
+
+      def _setup_delegation!(halibut_context)
+        @_halibut_context = halibut_context
+        methods = @_halibut_context.methods - Object.instance_methods
+        def_delegators(:@_halibut_context, *methods)
+      end
+
+      def _swap_context(another_context, &block)
+        original_context, @_halibut_context = @_halibut_context, another_context
+        yield
+      ensure
+        @_halibut_context = original_context
+      end
+
+      def _halibut_resource
+        @_halibut_context.instance_variable_get(:@resource)
+      end
+    end
+  end
+end

data/lib/halibut/rails/railtie.rb

@@ -0,0 +1,11 @@
+module Halibut
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'halibut-rails.initialize' do |app|
+        ActiveSupport.on_load(:action_view) do
+          require 'halibut/rails/builder_handler'
+        end
+      end
+    end
+  end
+end

data/lib/halibut/rails/version.rb

@@ -0,0 +1,5 @@
+module Halibut
+  module Rails
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: halibut-rails
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Toru KAWAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-07-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: halibut
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id002 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.5"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id005
+description: Rails Template Handler for Halibut Builder
+email: 
+- tkawa@4bit.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- halibut-rails.gemspec
+- lib/halibut/rails.rb
+- lib/halibut/rails/builder_handler.rb
+- lib/halibut/rails/context.rb
+- lib/halibut/rails/context_delegator.rb
+- lib/halibut/rails/railtie.rb
+- lib/halibut/rails/version.rb
+homepage: https://github.com/tkawa/halibut-rails
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Rails Template Handler for Halibut Builder
+test_files: []
+