RubyGems - elpong-rails - Versions diffs - 0.2.0 - Mend

elpong-rails 0.2.0

Files changed (10) hide show

checksums.yaml +7 -0
data/LICENSE +21 -0
data/README.md +31 -0
data/Rakefile +11 -0
data/lib/elpong/rails.rb +10 -0
data/lib/elpong/rails/helper.rb +49 -0
data/lib/elpong/rails/reloader.rb +16 -0
data/lib/elpong/rails/version.rb +5 -0
data/lib/generators/elpong_generator.rb +15 -0
metadata +87 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c1d51243ca69f2f13d48c1b71d46315906dd21a
+  data.tar.gz: b24e5aaaf399b733ef5aca652510d8699e21a222
+SHA512:
+  metadata.gz: 05edb05e6b20678ac68db73cb8b1b5a24e722d44140d6e899d5af95f4f92f825da4d6192087157814fe605b561c6e6dff7b10631d4672062a11477192efbb28c
+  data.tar.gz: 07d094e797966b5ccd514e0ac9e53a5ffbc55733e7426855d2988d649487f0fe2522e1922a1ec4ec93961ae47f29afdbb8ec0bd93509f4944ff75c1a559a059a

data/LICENSE ADDED

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2016 Hans Otto Wirtz
+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 ADDED

@@ -0,0 +1,31 @@
+# Elpong for Rails
+This library is meant for use with [Elpong for Javascript][js]
+You can put a `scheme.json` in the `/config` folder, and
+that will be used as the default scheme.
+```ruby
+gem 'elpong-rails'
+```
+```bash
+$ rails generate elpong
+```
+```ruby
+class ApplicationController < ActionController::Base
+  helper Elpong::Rails::Helper
+  # this provides methods like elpong_scheme and elpong_collection
+end
+```
+```html
+<head>
+  <%= elpong_scheme 'animal-farm' %>
+  <%= elpong_collection 'pigs', path: '/api/v1/pigs/index', locals: {pigs: @pigs} %>
+  <%= elpong_element 'user', path: '/api/v1/users/me', attributes: {'current-user': true} %>
+</head>
+```
+[js]: https://github.com/hansottowirtz/elpong-js

data/Rakefile ADDED

@@ -0,0 +1,11 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rake'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/elpong/rails.rb ADDED

@@ -0,0 +1,10 @@
+require 'elpong'
+require_relative 'rails/version'
+require_relative 'rails/helper'
+require_relative 'rails/reloader'
+module Elpong
+  module Rails
+  end
+end

data/lib/elpong/rails/helper.rb ADDED

@@ -0,0 +1,49 @@
+module Elpong
+  module Rails
+    module Helper
+      def elpong_scheme(name_or_scheme = nil)
+        scheme = get_scheme_from_name_or_scheme(name_or_scheme)
+        content_tag(:meta, nil, name: 'elpong-scheme', content: scheme.to_json, scheme: scheme.name)
+      end
+      def elpong_collection(name, options = {})
+        scheme = get_scheme_from_name_or_scheme(options[:scheme])
+        # options[:locals] ||=
+        throw new StandardError('No path') if !options[:path]
+        attributes = {
+          name: 'elpong-collection',
+          content: h( render(template: options[:path], locals: options[:locals] || {}) ),
+          scheme: scheme.name,
+          collection: name
+        }
+        content_tag(:meta, nil, attributes)
+      end
+      def elpong_element(singular_name, options = {})
+        scheme = get_scheme_from_name_or_scheme(options[:scheme])
+        throw new StandardError('No path') if !options[:path]
+        attributes = {
+          name: 'elpong-element',
+          content: h( render(template: options[:path], locals: options[:locals] || {}) ),
+          scheme: scheme.name,
+          collection: singular_name.pluralize
+        }
+        options[:attributes].each do |name, value|
+          attributes[name] = value
+        end
+        content_tag(:meta, nil, attributes)
+      end
+      private
+      def get_scheme_from_name_or_scheme(name_or_scheme)
+        if name_or_scheme.class == Elpong::Scheme
+          name_or_scheme
+        elsif name_or_scheme
+          Elpong.get_scheme(name_or_scheme)
+        else
+          Elpong.default_scheme
+        end
+      end
+    end
+  end
+end

data/lib/elpong/rails/reloader.rb ADDED

@@ -0,0 +1,16 @@
+module Elpong
+  module Rails
+    class Reloader
+      def initialize(app)
+        @app = app
+      end
+      def call(env)
+        Elpong.schemes.each do |scheme|
+          scheme.reload
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/elpong/rails/version.rb ADDED

@@ -0,0 +1,5 @@
+module Elpong
+  module Rails
+    VERSION = '0.2.0'
+  end
+end

data/lib/generators/elpong_generator.rb ADDED

@@ -0,0 +1,15 @@
+class ElpongGenerator < Rails::Generators::Base
+  desc 'This generator creates an initializer file at config/initializers'
+  def create_initializer_file
+    create_file 'config/initializers/elpong.rb', <<-'RUBY' # no interpolation of Rails.root
+scheme = Elpong::Scheme.new("#{Rails.root}/config/scheme.json")
+if Rails.env.development?
+  listener = Listen.to("#{Rails.root}/config", only: /^scheme.json$/) do
+    scheme.reload
+  end
+  listener.start
+end
+    RUBY
+  end
+end

metadata ADDED

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: elpong-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Hans Otto Wirtz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: elpong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description:
+email:
+- hansottowirtz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/elpong/rails.rb
+- lib/elpong/rails/helper.rb
+- lib/elpong/rails/reloader.rb
+- lib/elpong/rails/version.rb
+- lib/generators/elpong_generator.rb
+homepage: https://github.com/hansottowirtz/elpong-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.6
+signing_key:
+specification_version: 4
+summary: Elpong for Rails
+test_files: []
+has_rdoc: