rails_script 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5b46f04cb39d9d79a4f57d88e536c2f2527b179
-  data.tar.gz: 0a9f9c488c7d8c0a6afe31a4b9afd13b2f2d4cd5
+  metadata.gz: 42da47403244af3f7022e32f31a41c67d525fdce
+  data.tar.gz: 3b2997d390db2520b960d7e292e7c1fa98ba6e62
 SHA512:
-  metadata.gz: d3a613986d7760ce2d3e60b5b604c7760fb0d02590ef46be91a6d3d737288cfdf255ef60a4440cb70644111fb56cc4605dc6b1cc8bee052d248184c40f8ab16e
-  data.tar.gz: 142aab5ca3b550b0b95c0745743fc5f108213287efc22a35113ecc5dba75c2dfebf4edaa1d7faf4d7830f920d0d06677247ba62a91722bbd7101c8b885d93065
+  metadata.gz: a6259364d8b6cc1ff284c5d27e89b740ea3f1b5c40cf182e8324c41bc74e413f4ee0cd3efdf2440c6a45fde288211e378d65cb7f6fb8ff83234c42f2643a2d59
+  data.tar.gz: 7a62b691ae316b692452bc8fa136d831a8b6e242f03fed4c2946d1e5feef3ea370a6f94d5ca3f707f9c3b3ff93ffc17f161a022648af3ac0a464bc4649d673e6

data/README.md

@@ -1,6 +1,6 @@
-# RailsScript
+# Rails Script
 
-TODO: Write a gem description
+Rails Script is a Rails-centric, object oriented, featherweight framework for writting CoffeeScript.  It is optomized for the [Rails Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html) and is compatible with [TurboLinks](https://github.com/rails/turbolinks).  Using Rails controller names and actions to call JavaScript, it has never been easier to write clean, concise, and maintanable page specific JavaScript.
 
 ## Installation
 
@@ -11,14 +11,156 @@ Add this line to your application's Gemfile:
 And then execute:
 
     $ bundle
+    
+After bundling you need to run the initial installation generator:
 
-Or install it yourself as:
+    $ rails g rails_script:install
+    
+After the generator finishes, you will be prompted to add some JavaScript to your application layout.  The code is responsible for initializing and call the action specific JavaScript.  This snippet should be added before the closing body tag.
 
-    $ gem install rails_script
+For ERB:
+```
+<script>
+  jQuery(function() {
+    window.$this = new (App.<%= controller_path.split(/\/|_/).map(&:capitalize).join('') %> || App.Base)();
+    if (typeof $this.<%= action_name %> === 'function') {
+      return $this.<%= action_name%>.call();
+    }
+  });
+</script>
+```
+
+For HAML:
+```
+:javascript
+  jQuery(function() {
+    window.$this = new (App.#{controller_path.split(/\/|_/).map(&:capitalize).join('')} || App.Base)();
+    if (typeof $this.#{action_name} === 'function') {
+      return $this.#{action_name}.call();
+    }
+  });
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Global Functions
+
+Any functions that need to be accessible in the global scope should be defined in ```global.js.coffee``` using the ```App``` namespace.  Below is an example of one of our favorite functions that we use to submit a form using AJAX as a JSON request.
+
+```
+# app/assets/javascripts/global.js.coffee
+window.App ||= {}
+
+App.remoteSubmission = ($form, onCompleteCallBack) ->
+  $.ajax
+    url: $form.attr('action')
+    type: $form.attr('method')
+    data: $form.serialize()
+    dataType: 'json'
+    complete: (result) ->
+      onCompleteCallBack(result)
+
+  return
+```
+
+Now you can access this function from anywhere in the application by just calling ```App.remoteSubmission($('#myForm'), alert('Hello'))```
+
+
+### Page Specific JavaScript
+
+This is where things get even easier, your JavaScript class is named after your Controller and there is a method for each Controller action.  Whenever you generate a Controller, the CoffeeScript file that is generated will define the new JavaScript class and the basic REST actions.  This means on ```Users#show``` we can submit that 'follow' request in the background like so:
+
+```
+# app/assets/javascripts/users.js.coffee
+
+window.App ||= {}
+class App.Users extends App.Base
+
+   show: ->
+      App.remoteSubmission($('#follow-user-form'), alert('You are now following them!'))
+```
+
+
+### Controller Specific JavaScript
+
+Executing some JavaScript to run on all controller actions is just a matter of adding it to the class contstructor.  In the below example we will change the background color of the page for all actions in ```UsersController```.
+
+```
+# app/assets/javascripts/users.js.coffee
+window.App ||= {}
+class App.Example extends App.Base
+
+  constructor: ->
+    super
+    $('body').css('background-color', 'yellow')
+    return this
+```
+
+Note the call to ```super``` and the ```return this```, it is very important to keep these.  If you wanted your Controller specific JavaScript to run before Application wide JavaScript, then you would call ```super``` just before ```return this```.  Returning ```this``` allows the Application layout JavaScript to call the action specific functions.
+
+
+### Application Wide JavaScript
+
+Running some JavaScript on every page of an Application is a common need.  For example, we may want to create a site credit rollover in the footer of every page.
+
+```
+# app/assets/javascripts/base.js.coffee
+window.App ||= {}
+class App.Base
+
+  constructor: ->
+    @footerRollover()
+    return this
+    
+  footerRollover: ->
+    $(".site-credit a").hoverIntent(
+      over: ->
+        $(".site-credit a").html("<div class='maui-logo'></div>")
+      out: ->
+        $(".site-credit a").html("SITE CREDIT")
+    )
+```
+
+In this example we extracted the rollover action into a new function.  Doing so will make the class cleaner and easier to maintain as the application grows.  Once again note the ```return this``` in the contructor.
+
+
+### Generating New Controllers
+
+When a new controller is generated, the JavaScript asset file will be generated with Rails Script.  However, if you need to manually generate a Rails Script controller you can use:
+
+    $ rails g rails_script:controller Some::NewController
+    
+Since the above example includes a namespace, it would generate:
+
+```
+# app/assets/javascripts/some/new_controller.js.coffee
+
+window.App ||= {}
+class App.SomeNewController extends App.Base
+
+  constructor: ->
+    super
+    return this
+
+
+  index: ->
+    return
+
+
+  show: ->
+    return
+
+
+  new: ->
+    return
+
+
+  edit: ->
+    return
+```
+
+None of the pre-defined functions are necessary, you can remove the ones you don't want.
+
 
 ## Contributing
 

data/lib/generators/rails_script/install/install_generator.rb

@@ -26,18 +26,18 @@ In order to complete installation, you must add the following JavaScript snippet
 
 ERB:
 <script>
-jQuery(function() {
-    window.$this = new (App.\#{controller_path.split(/\/|_/).map(&:capitalize).join('')} || App.Base)();
-    if (typeof $this.\#{action_name} === 'function') {
-      return $this.\#{action_name}.call();
+  jQuery(function() {
+    window.$this = new (App.<%= controller_path.split(/\\/|_/).map(&:capitalize).join('') %> || App.Base)();
+    if (typeof $this.<%= action_name %> === 'function') {
+      return $this.<%= action_name%>.call();
     }
-});
+  });
 </script>
 
 HAML:
 :javascript
   jQuery(function() {
-    window.$this = new (App.\#{controller_path.split(/\/|_/).map(&:capitalize).join('')} || App.Base)();
+    window.$this = new (App.\#{controller_path.split(/\\/|_/).map(&:capitalize).join('')} || App.Base)();
     if (typeof $this.\#{action_name} === 'function') {
       return $this.\#{action_name}.call();
     }

data/lib/rails_script/version.rb

@@ -1,3 +1,3 @@
 module RailsScript
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/templates/coffee/assets/javascript.js.coffee

@@ -1,5 +1,5 @@
 window.App ||= {}
-class App.<%= class_name  %> extends App.Base
+class App.<%= class_name %> extends App.Base
 
   constructor: ->
     super

data/rails_script.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = RailsScript::VERSION
   spec.authors       = ['Kevin Pheasey']
   spec.email         = ['kevin.pheasey@gmail.com']
-  spec.summary       = %q{A CoffeeScript framework for the Rails asset pipeline.}
-  spec.description   = %q{A CoffeeScript framework for the Rails asset pipeline.}
+  spec.summary       = %q{A Rails-centric, object oriented, featherweight framework for writting CoffeeScript}
+  spec.description   = %q{Rails Script is a Rails-centric, object oriented, featherweight framework for writting CoffeeScript. It is optomized for the Rails Asset Pipeline and is compatible with TurboLinks. Using Rails controller names and actions to call JavaScript, it has never been easier to write clean, concise, and maintanable page specific JavaScript.}
   spec.homepage      = 'https://github.com/gemgento/rails_script'
   spec.license       = 'MIT'
 
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake', '~> 0'
 
-  spec.add_dependency 'coffee-rails', '~> 4.0.0'
+  spec.add_dependency 'coffee-rails', '~> 4.0', '>= 4.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_script
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kevin Pheasey
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -43,6 +43,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
@@ -50,9 +53,15 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-description: A CoffeeScript framework for the Rails asset pipeline.
+description: Rails Script is a Rails-centric, object oriented, featherweight framework
+  for writting CoffeeScript. It is optomized for the Rails Asset Pipeline and is compatible
+  with TurboLinks. Using Rails controller names and actions to call JavaScript, it
+  has never been easier to write clean, concise, and maintanable page specific JavaScript.
 email:
 - kevin.pheasey@gmail.com
 executables: []
@@ -99,5 +108,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A CoffeeScript framework for the Rails asset pipeline.
+summary: A Rails-centric, object oriented, featherweight framework for writting CoffeeScript
 test_files: []