rails-js 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 931d5dbd625d0ce4bd1edd2b08aa70e36f75af58
-  data.tar.gz: 09fb2738423fbbb26754ec6c2b7292ae150a2d5d
+  metadata.gz: b7a095e9cfffa3e1d2b2c014a5337274493cd77a
+  data.tar.gz: e95794d144143f42b1cc83cc919ee619c0d6986e
 SHA512:
-  metadata.gz: 6246edb935192928bbbfc916b96ba532238cda5e0676e3a37b37b79ad26018b2b184a97b68614ebe500de7712b886386aced11b1a47a9667e6b360f7140e7797
-  data.tar.gz: 75ec23dccf39596a86512a3e4cc5c44881043a1bcea8ea297d2ba3eb0a1fc592ed8af51df367a37296ba5aa7fe24f455e8743fcb8dfb119b77057e97bf879809
+  metadata.gz: 47ced54a87c6dbad5d2b70e8cd08d940bc892204cb04ae184945e053746b93179b43a6e52f471a81458d92fcaff46413372c745b38e8a2cf4c6a0e2f6f73abf8
+  data.tar.gz: 9caa7c7725d5381a0874a43371ede315b1a45fea9803cfa841e479f234c452435ebaae08c188a263c999af7d8e015385b1a30a6a3ad42c6bd938f3a28e76a3c1

data/.gitignore

@@ -1 +1,3 @@
 *.gem
+test/dummy/tmp/
+test/dummy/log/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in penis.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    rails-js (0.0.2)
+      rails (~> 4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      mail (~> 2.5.4)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
+      arel (~> 5.0.0)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    capybara (2.2.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    cliver (0.3.2)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    mini_portile (0.6.0)
+    minitest (5.3.5)
+    multi_json (1.10.1)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    poltergeist (1.5.1)
+      capybara (~> 2.1)
+      cliver (~> 0.3.1)
+      multi_json (~> 1.0)
+      websocket-driver (>= 0.2.0)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.1)
+      actionmailer (= 4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      activemodel (= 4.1.1)
+      activerecord (= 4.1.1)
+      activesupport (= 4.1.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.1)
+      sprockets-rails (~> 2.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    sprockets (2.12.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.9)
+    teaspoon (0.8.0)
+      railties (>= 3.2.5, < 5)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+    websocket-driver (0.3.4)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  poltergeist (~> 1.5)
+  rails-js!
+  sqlite3 (~> 1.3)
+  teaspoon (~> 0.8)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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

@@ -1,4 +1,134 @@
-rails.js
+rails-js
 ========
 
-A new approach to structure your javascript in non single-page Rails apps
+I worked on several Rails projects and there were many cases when it felt overkill to use a framework like ``Angular`` or ``Ember``, because javascript was only needed in some parts of the application.
+But by not using these frameworks I had to think of a way to *structure* the code by myself.
+I came up with the conclusion to organize the javascript code like the ruby code is organized, that means: __Split up in controllers, which are split up in actions.__
+
+## How it works
+* In ``rails-js`` we are able to define ``controllers``, as well as ``helpers``.
+* Controllers have ``actions`` which are executed when the matching rails action is executed.
+* Helpers should be clear. Pretty much like the rails helpers. There are helper per controller and global helpers.
+* The gem also provides a ``view helper`` to use in your layouts, which passes the routing information to ``rails-js``.
+
+#### You start by creating an app.
+
+```js
+//= rails
+
+/*
+ * app/assets/javascripts/application.js
+ */
+ 
+Rails.app({
+ // Define global helpers here
+ helper: function() {
+ }
+},
+ // Put in initial data
+{
+  foo: 'bar'
+},
+// A function that is executed before every action
+function() {
+ console.log('beforeAll() executed');
+});
+
+```
+#### Create controllers accordingly.
+
+```js
+
+/*
+ * app/assets/javascripts/controllers/users.js
+ */
+
+Rails.controller('users', {
+  // actions here
+  new: function(h) {
+    // execute helper
+    h.awesomeHelper();
+  },
+  
+  index: function(h) {
+    // Do the same as in new()
+    this.index(h);
+  }
+},
+{
+  // helpers here
+  function awesomeHelper() {
+  }
+});
+
+```
+
+
+#### Use code from other controllers.
+```js
+
+/*
+ * app/assets/javascripts/controllers/admin/users.js
+ */
+ 
+Rails.controller('admin/users', {
+  new: function(h) {
+    // Execute action of foreign controller
+    R.action('users#new');
+  },
+  
+  index: function(h) {
+    // Execute foreign helper with arguments
+    R.helper('users', 'awesomeHelper', 1, 2, 3);
+    
+    // Execute global helper with arguments
+    R.global('helper', 1, 2, 3);
+  }
+},{});
+
+```
+
+
+#### Global variables without the mess.
+```js
+/*
+ * Use R singleton everywhere
+ */
+
+// Setting
+R('answer', 42);
+// Multiple levels
+R('a.global.variable', 'foo');
+
+// Getting
+console.log(R('a.global.variable'));
+```
+
+
+#### Define hooks for namespaces.
+```js
+/*
+ * app/assets/javascripts/namespaces/admin.js
+ */
+ 
+Rails.namespace('admin', function() {
+  // Will be executed on all admin routes (e.g. admin/users#new)
+  console.log('Hello Mr. Admin');
+});
+```
+
+#### For more info...
+...just read in ``app/assets/javascripts/rails.js``. I tried my best and documented nearly every line of code :) 
+
+Installing
+==========
+
+Install it as any other gem by putting this to your ``Gemfile``:
+```ruby
+gem 'rails-js'
+```
+In your layouts, put this line into the ``head``:
+```erb
+<%= rails_js %>
+```
+Also make sure to include ``rails`` in your ``application.js``.

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/rails/js/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module JS
+    VERSION = "0.0.2"
+  end
+end

data/rails-js.gemspec

@@ -1,6 +1,11 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "rails/js/version"
+
 Gem::Specification.new do |s|
   s.name          = 'rails-js'
-  s.version       = '0.0.1'
+  s.version       = Rails::JS::VERSION
   s.date          = '2014-10-11'
   s.summary       = "A new approach to structure your javascript in non single-page Rails apps"
   s.description   = "Divide your javascript like you divide your ruby code. Put it in controllers and actions and write clean, scalable code."
@@ -10,4 +15,9 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.homepage      = 'http://rubygems.org/gems/rails-js'
   s.license       = 'MIT'
+
+  s.add_dependency "rails", "~> 4.1"
+  s.add_development_dependency "sqlite3", "~> 1.3"
+  s.add_development_dependency "teaspoon", "~> 0.8"
+  s.add_development_dependency "poltergeist", "~> 1.5"
 end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails
+//= require_tree .

data/test/dummy/app/assets/javascripts/testing.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end