riot_js-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d683957b5d3a585f6e493b42f17f4908075264b
-  data.tar.gz: 8532cc7d6277124a95475144d6198b6774e30bfc
+  metadata.gz: c2caab9b9960cca67b7470af50ce43bb3daca763
+  data.tar.gz: 6fd2a649d36cfee3669b1fedf839647a2d56f105
 SHA512:
-  metadata.gz: 771a137a6e2e9e16a327b1b12e9b65f30fbc0dff2bab1b4983188a6a54a1e6167f1817a54d83ab12b8189589866455a68595260f2ef1fa64a1a440aaa36991dd
-  data.tar.gz: a7b03afec4071dfee9105283308b82d706c6f670c10dd528405b4ae5fa74f755569752ac7d0dd08132f06a40cdd56cab40b20f6f033f7ee6748d749966d8f261
+  metadata.gz: b076a2783b991b3e2f29e8973f8bfd9b2ec08395960257482073dd9d8a8324c38d6fa0c4b21b16dbf0d951cc315417c4cb5d21a3af9a740ba3fa58a73e525769
+  data.tar.gz: 881f5d86d9ca7844b10efb615320203fb7973035b1515c90cbaedf28a9eee7c533d20f91b42fc2dad6ae3c7084f68f63b17f11313dced0b88f241bb5a17e811d

data/README.md

@@ -2,6 +2,13 @@
 
 Muut Riot integration with Rails
 
+## Requirements
+
+ 1. Nodejs - for tags compiling.
+ 2. jQuery - for tags mounting (if you're going to use helpers provided by gem).
+ 3. Rails 3 and 4 supported
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -10,13 +17,87 @@ Add this line to your application's Gemfile:
 gem 'riot_js-rails'
 ```
 
-And then execute:
+Execute:
 
-    $ bundle
+    $ bundle install
+    
+Add ```riot``` and ```riot_rails``` to your ```application.js```:
+```
+//= require riot
+//= require riot_rails
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Put all your components somewhere into ```assets/javascript```. All components tags must have ```.tag``` extension (if you use older version of sprockets, try ```.js.tag```) and need to be required in your ```application.js```. This will compile component to Javascript.
+
+
+## Helpers
+
+Each component has to be mounted. It can be done by executing ```riot.mount``` in javascript, e.g.:
+```javascript
+$(function() {
+  riot.mount('example-tag');
+});
+```
+
+
+Alternative approach is to use view helper, e.g.:
+
+```ruby
+<%= riot_component(:example_tag, { :header => 'Some header' }) %>
+```
+This will generate following HTML:
+```html
+<example-tag id="riot-example-tag-2822884" class="riot-rails-component"></example-tag>
+```
+and immediate mount it with given options.
+
+You can also use HTML element as tag:
+```ruby
+<%= riot_component(:div, :example_tag, { :header => 'Some header' }) %>
+```
+which will generate following code:
+```html
+<div id="riot-example-tag-5012227" class="riot-rails-component" riot-tag="example-tag"></div>
+```
+
+To generate tag with content use block:
+```ruby
+<%= riot_component(:example_tag, { :header => 'Some header' }) do %>
+  <p>Content</p>
+<% end %>
+```
+
+If you want to add your own classes to component or any other attributes, pass it as last argument:
+```ruby
+<%= riot_component(:div, :example_tag, { :header => 'Some header' }, { class: 'my-class' }) %>
+```
+
+# HAML, SASS and CoffeeScript
+
+You can define tag using HAML, SASS and CoffeeScript. Example:
+```haml
+%example-haml
+  %h1{ onclick: "{change_header}" }
+    = "{header}"
+
+  :scss
+    timer-haml {
+      h1 {
+        background-color: #ffff00;
+      }
+    }
+
+  :coffee
+    self = this
+    this.header = opts.header
+
+    this.change_header = ()->
+      self.header = 'New header'
+```
+
+Note: file has to have ```.tag.haml``` extension (or ```.js.tag.haml``` for older version of Sprockets)
 
 ## Contributing
 

data/lib/riot_js/rails.rb

@@ -1,4 +1,5 @@
 require 'riot_js/rails/version'
+require 'sprockets'
 require 'riot_js/rails/engine' if defined?(Rails)
 require 'riot_js/rails/railtie' if defined?(Rails)
 

data/lib/riot_js/rails/helper.rb

@@ -3,38 +3,35 @@ module RiotJs
     module Helper
 
       def riot_component(*args, &block)
-        case args.count
-          when 2
-            custom_tag_riot_component(*args, &block)
-          when 3
-            html_tag_riot_component(*args, &block)
-          else
-            raise ArgumentError, 'wrong number of arguments (required 2 or 3)'
+        if args[1].kind_of?(Hash)
+          custom_tag_riot_component(*args, &block)
+        else
+          html_tag_riot_component(*args, &block)
         end
       end
 
       private
 
-      def custom_tag_riot_component(name, data, &block)
-        component_name, attributes = component_attributes(name, data)
+      def custom_tag_riot_component(name, data, attributes={}, &block)
+        component_name, attributes = component_attributes(name, data, attributes)
 
         component_tag(component_name, attributes, &block)
       end
 
-      def html_tag_riot_component(tag, name, data, &block)
-        component_name, attributes = component_attributes(name, data)
+      def html_tag_riot_component(tag, name, data, attributes={}, &block)
+        component_name, attributes = component_attributes(name, data, attributes)
         attributes['riot-tag'] = component_name
 
         component_tag(tag, attributes, &block)
       end
 
-      def component_attributes(name, data)
+      def component_attributes(name, data, attributes)
         component_name = name.to_s.gsub('_', '-')
-        attributes = {
-          id: "riot-#{component_name}-#{Random.rand(10000000)}",
-          class: 'riot-rails-component',
-          data: { opts: data.to_json }
-        }
+        attributes_data = attributes[:data] || attributes['data'] || {}
+        attributes_class = attributes[:class] || attributes['class']
+        attributes = attributes.merge(id: "riot-#{component_name}-#{Random.rand(10000000)}",
+                                      class: "#{attributes_class} riot-rails-component".strip,
+                                      data: attributes_data.merge(opts: data.to_json))
         return component_name, attributes
       end
 

data/lib/riot_js/rails/processors/compiler.rb

@@ -1,6 +1,5 @@
 require 'action_view'
 require 'execjs'
-require 'byebug'
 
 module RiotJs
   module Rails
@@ -35,4 +34,4 @@ module RiotJs
 
     end
   end
-end
+end

data/lib/riot_js/rails/processors/processor.rb

@@ -1,34 +1,24 @@
 require 'riot_js/rails/processors/compiler'
 
+if Gem::Version.new(Sprockets::VERSION) < Gem::Version.new('3.0.0')
+  require 'riot_js/rails/processors/sprockets_processor_v2'
+else
+  require 'riot_js/rails/processors/sprockets_processor_v3'
+end
+
 module RiotJs
   module Rails
-    class Processor
-      def self.instance
-        @instance ||= new
-      end
-
-      def self.call(input)
-        instance.call(input)
-      end
+    class Processor < SprocketsProcessor
 
-      def call(input)
-        prepare(input)
-
-        data = compile_tag
-
-        @context.metadata.merge(data: data)
+      def process
+        compile_tag
       end
 
       private
 
-      def prepare(input)
-        @context = input[:environment].context_class.new(input)
-        @data = input[:data]
-      end
-
       def compile_tag
         ::RiotJs::Rails::Compiler.compile(@data)
       end
     end
   end
-end
+end

data/lib/riot_js/rails/processors/sprockets_processor_v2.rb

@@ -0,0 +1,26 @@
+module RiotJs
+  module Rails
+    class SprocketsProcessor < Tilt::Template
+
+      self.default_mime_type = 'application/javascript'
+
+      def self.register_self(app)
+        app.assets.register_engine '.tag', self
+      end
+
+      def evaluate(context, locals, &block)
+        @context = context
+        process
+      end
+
+      def prepare
+        @data = data
+      end
+
+      def process
+        raise 'Not implemented'
+      end
+
+    end
+  end
+end

data/lib/riot_js/rails/processors/sprockets_processor_v3.rb

@@ -0,0 +1,36 @@
+module RiotJs
+  module Rails
+    class SprocketsProcessor
+      def self.instance
+        @instance ||= new
+      end
+
+      def self.call(input)
+        instance.call(input)
+      end
+
+      def call(input)
+        prepare(input)
+        data = process
+
+        @context.metadata.merge(data: data)
+      end
+
+      def self.register_self(app)
+        app.assets.register_engine '.tag', self, mime_type: 'application/javascript'
+      end
+
+      private
+
+      def process
+        raise 'Not implemented'
+      end
+
+      def prepare(input)
+        @context = input[:environment].context_class.new(input)
+        @data = input[:data]
+      end
+
+    end
+  end
+end

data/lib/riot_js/rails/railtie.rb

@@ -6,11 +6,11 @@ module RiotJs
   module Rails
     class Railtie < ::Rails::Railtie
       initializer :setup_sprockets do |app|
-        app.assets.register_engine '.tag', Processor, mime_type: 'application/javascript'
+        Processor.register_self app
 
         if defined?(::Haml)
           require 'tilt/haml'
-          app.assets.register_engine '.haml', ::Tilt::HamlTemplate, mime_type: 'text/html'
+          app.assets.register_engine '.haml', ::Tilt::HamlTemplate
         end
       end
 
@@ -22,4 +22,4 @@ module RiotJs
 
     end
   end
-end
+end

data/lib/riot_js/rails/version.rb

@@ -1,5 +1,5 @@
 module RiotJs
   module Rails
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

data/riot_js-rails.gemspec

@@ -20,11 +20,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
 
-  spec.add_dependency 'rails', '~> 4'
+  spec.add_dependency 'rails', '>= 3.0', '< 4.3'
   spec.add_dependency 'execjs', '~> 2'
 
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.1'
   spec.add_development_dependency 'byebug', '~> 5.0'
+  spec.add_development_dependency 'mocha', '~> 1.0'
 end

data/vendor/assets/javascripts/riot_rails.js

@@ -1,7 +1,7 @@
 ;(function($) {
 
   var riotRails = {
-    componentSelector: '.riot-rails-component',
+    componentClass: 'riot-rails-component',
     mounted: [],
     mount: function(selector) {
       var component = $(selector);
@@ -18,7 +18,7 @@
     },
     mountAll: function() {
       var self = this;
-      $(self.componentSelector).each(function(){
+      $('.' + self.componentClass).each(function(){
         self.mount('#' + $(this).attr('id'));
       });
     }

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: riot_js-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bartosz Jaroszewski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2015-08-27 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'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: This gem provides integration of Muut Riot with Rails
 email:
 - b.jarosze@gmail.com
@@ -110,6 +130,8 @@ files:
 - lib/riot_js/rails/helper.rb
 - lib/riot_js/rails/processors/compiler.rb
 - lib/riot_js/rails/processors/processor.rb
+- lib/riot_js/rails/processors/sprockets_processor_v2.rb
+- lib/riot_js/rails/processors/sprockets_processor_v3.rb
 - lib/riot_js/rails/railtie.rb
 - lib/riot_js/rails/version.rb
 - riot_js-rails.gemspec