rails_script 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: b863825eaf502b0fe59a592d6288c65b9b227f9d
-  data.tar.gz: 7c0d246d78e0d5ccf0a4ff3b14e114f04e82475f
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWIxY2ZiNzBjYjVkMTU4MGMzZmIyN2Q5ZGVmZTgzNjE5NGRmOGFlMg==
+  data.tar.gz: !binary |-
+    MjQ2M2VkZjY5NDgxNjk1ZTE2OGFhMjMwZmI1YjU1MzE2M2MzNTRhMA==
 SHA512:
-  metadata.gz: 4b8a2ac4612b90c9e133e80f19a5d06e644c67b53921798b5082528897dd8b26488d2381d917d0ea82bdc24bf0798615c97a742ba9c91b1a3feaa93f4b63f5ac
-  data.tar.gz: 178f4c5a371cbe3c949d2da8946222340c9bb5d22703762b97ed3e071dc5ab8d6cc1223954756d66e7dd2003cd766d626bf8842092da50c1fb19b5a405f2caac
+  metadata.gz: !binary |-
+    M2M4NmI0NDc5Y2Q3ZjRiNGVjZWRmODg4NzQ2OWQ2Yjk1ZTZiMDk1Yzg3MTBl
+    ZjI5NTA1NWExMmQ2OGY5NDAzNjAxOWFhMWY4ZmFmN2ZmYTk2ZDlmN2QxNDdl
+    Y2U3ZDE0M2M2NGEwMTc0MDZkYTlmMjc4Y2U1Zjc4ZmQyYjk2NWM=
+  data.tar.gz: !binary |-
+    ZWJlYTZlNGIyNjdhYTMzNWNhMGQxNzNlYTM0MWViYWNiZjEwMTRkZjA4Zjgw
+    ZmMyMDU0ODBjMWJmNmQ0ZTU1ZjdkYTJkOGZlNGY1N2E4ODJkZjhiNDFkY2E0
+    OWY4ZmE4OTJiZGMyMDgxOTI2NzhhYjU5YmQyZTRiZjUzZTQ5YTE=

data/README.md

@@ -6,7 +6,7 @@ RailsScript is a Rails-centric, object oriented, featherweight framework for wri
 
 Add this line to your application's Gemfile:
 
-    gem 'rails_script', '~> 0.6.0'
+    gem 'rails_script', '~> 0.6.1'
 
 And then execute:
 
@@ -22,13 +22,18 @@ After the generator finishes, you will be prompted to add helper call to your ap
 <%= include_rails_script %>
 ```
 
+NOTE: Your JS files needed have been included before `include_rails_script`.  In other words, you still need `<%= javascript_include_tag "application" %>` in your application layout.
+
+## Configuration
+You can configure name of your application in config/initializers/rails_script.rb file.
+
 ## Usage
 
 ### Page (Action) Specific JavaScript
 
 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.  The example below would print 'users#show' in the console for the ```Users#show``` action.
 
-```
+```coffeescript
 # app/assets/javascripts/users.js.coffee
 
 window.App ||= {}
@@ -42,9 +47,9 @@ class App.Users extends App.Base
 
 ### Controller Specific JavaScript
 
-Executing some JavaScript to run on all controller actions is just a matter of adding it to the ```beforeAction``` or ```afterAction``` function.  ```beforeAction``` is run before all controller action functions and ```afterAction``` is run after all controller action functions.  The before and after action functions have an optional argument ```action``` which is string containing the current action name. The example below would print 'before ACTION action' and 'after ACTION action' for each ```Users``` controller action.  
+Executing some JavaScript to run on all controller actions is just a matter of adding it to the ```beforeAction``` or ```afterAction``` function.  ```beforeAction``` is run before all controller action functions and ```afterAction``` is run after all controller action functions.  The before and after action functions have an optional argument ```action``` which is a string containing the current action name. The example below would print 'before ACTION action' and 'after ACTION action' for each ```Users``` controller action.  
 
-```
+```coffeescript
 # app/assets/javascripts/users.js.coffee
 window.App ||= {}
 class App.Users extends App.Base
@@ -53,7 +58,7 @@ class App.Users extends App.Base
     console.log "before #{action} action"
     
   afterAction: (action) =>
-      console.log "after #{action} action"
+    console.log "after #{action} action"
 ```
 
 
@@ -61,7 +66,7 @@ class App.Users extends App.Base
 
 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.
 
-```
+```coffeescript
 # app/assets/javascripts/base.js.coffee
 window.App ||= {}
 class App.Base
@@ -87,18 +92,16 @@ In this example we extracted the rollover action into a new function.  Doing so
 
 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.
 
-```
+```coffeescript
 # app/assets/javascripts/global.js.coffee
 window.App ||= {}
 
 App.remoteSubmission = ($form) ->
-  $.ajax
+  return $.ajax
     url: $form.attr('action')
     type: $form.attr('method')
     data: $form.serialize()
     dataType: 'json'
-
-  return
 ```
 
 Now you can access this function from anywhere in the application by just calling ```App.remoteSubmission($('#myForm'))```
@@ -115,7 +118,7 @@ First, generate the ```Utility```
     
 This will create the following in ```/app/assets/javascripts/utilities/modal.js.coffee```:
 
-```
+```coffeescript
 # /app/assets/javascripts/utilities/modal.js.coffee
 window.Utility ||= {}
 class Utility.Modal
@@ -126,7 +129,7 @@ class Utility.Modal
 
 Let's add some basic functionality:
 
-```
+```coffeescript
 # /app/assets/javascripts/utilities/modal.js.coffee
 window.Utility ||= {}
 class Utility.Modal
@@ -156,7 +159,7 @@ class Utility.Modal
 
 Now, here's how we use the utility from ```users#show```
 
-```
+```coffeescript
 # app/assets/javascripts/users.js.coffee
 
 window.App ||= {}
@@ -179,7 +182,7 @@ First generate the ```Element```
     
 This will create the following in ```/app/assets/javascripts/elements/main_menu.js.coffee```
 
-```
+```coffeescript
 # /app/assets/javascripts/elements/main_menu.js.coffee```
 
 window.Element ||= {}
@@ -191,7 +194,7 @@ class Element.MainMenu
 
 We can now add all the logic for the main menu in a separate class and call it on every page like so:
 
-```
+```coffeescript
 # app/assets/javascripts/base.js.coffee
 
 window.App ||= {}
@@ -212,7 +215,7 @@ Inheritance is another key tool for reusability.  Let's say our ```Element.MainM
     
 Which generates:
 
-````
+````coffeescript
 # /app/assets/javascripts/elements/main_menu.js.coffee
 
 window.Element ||= {}
@@ -234,7 +237,7 @@ When a new controller is generated, the JavaScript asset file will be generated
     
 Since the above example includes a namespace, it would generate:
 
-```
+```coffeescript
 # app/assets/javascripts/some/new_controller.js.coffee
 
 window.App ||= {}
@@ -276,7 +279,7 @@ To generate a generic class that isn't a Utility, Element or Controller, just us
     
 Which generates:
 
-```
+```coffeescript
 # /app/assets/javascripts/my/class_name.js.coffee
 
 window.App ||= {}
@@ -294,7 +297,7 @@ class App.MyClassName
 To pass data from Rails to JavaScript, just call ```to_javascript``` along with a hash of your data.  This is then converted to a JSON object with ```to_javascript.to_json``` and can be accessed with ```Utility.RailsVars```.  The ```to_javascript``` helper may be called from multiple points in the application, all data is merged together. 
 
 Here's an example where ```to_javascript``` is used in a ```before_filter``` to pass the current user and their friends:
-```
+```ruby
 # /app/controllers/application_controller.rb
 
 class ApplicationController
@@ -312,7 +315,7 @@ end
 
 And here's how we print that data to the console on the ```users#index``` action:
 
-```
+```coffeescript
 # /app/assets/javascripts/users.js.coffee
 
 window.App ||= {}
@@ -331,6 +334,11 @@ Since Turbolinks doesn't refresh the page and only replaces the body, event list
 
 
 
+### Page Transitions
+
+Full page transitions are super easy with RailsScript and Turbolinks.  Checkout the wiki for more information on how to add these to your RailsScript application, https://github.com/gemgento/rails_script/wiki/Turbolinks-Page-Transitions.
+
+
 
 ## Contributing
 

data/lib/generators/rails_script/class/templates/javascript.js.coffee

@@ -1,5 +1,5 @@
-window.App ||= {}
-class App.<%= class_name.gsub('::', '') %>
+window.<%= RailsScript.app_namespace %> ||= {}
+class <%= RailsScript.app_namespace %>.<%= class_name.gsub('::', '') %>
 
   constructor: ->
-    return this
+    return this

data/lib/generators/rails_script/controller/templates/javascript.js.coffee

@@ -1,5 +1,5 @@
-window.App ||= {}
-class App.<%= controller.gsub('::', '') %> extends App.Base
+window.<%= RailsScript.app_namespace %> ||= {}
+class <%= RailsScript.app_namespace %>.<%= controller.gsub('::', '') %> extends <%= RailsScript.app_namespace %>.Base
 
   beforeAction: (action) =>
     return
@@ -22,4 +22,4 @@ class App.<%= controller.gsub('::', '') %> extends App.Base
 
 
   edit: =>
-    return
+    return

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

@@ -6,6 +6,7 @@ module RailsScript
       def copy_files
         template 'base.js.coffee', 'app/assets/javascripts/base.js.coffee'
         template 'global.js.coffee', 'app/assets/javascripts/global.js.coffee'
+        template 'rails_script.rb', 'config/initializers/rails_script.rb'
       end
 
       def create_directories

data/lib/generators/rails_script/install/templates/base.js.coffee

@@ -1,5 +1,5 @@
-window.App ||= {}
-class App.Base
+window.<%= RailsScript.app_namespace %> ||= {}
+class <%= RailsScript.app_namespace %>.Base
 
   constructor: ->
     if (window.jQuery) then @setClearEventHandlers() # clearing application event handlers only possible with jQuery

data/lib/generators/rails_script/install/templates/global.js.coffee

@@ -1 +1 @@
-window.App ||= {}
+window.<%= RailsScript.app_namespace %> ||= {}

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

@@ -0,0 +1,4 @@
+RailsScript.config do |c|
+  # Configure name that will be used to namespace the javascript classes
+  c.app_namespace = "App"
+end

data/lib/rails_script/loader_helper.rb

@@ -7,7 +7,7 @@ window.Utility || (window.Utility = {});
 Utility.RailsVars = #{@to_javascript.nil? ? '{}' : @to_javascript.to_json};
 
 (function() {
-  window.$this = new (App.#{ controller_path.split(/\/|_/).map(&:capitalize).join('') } || App.Base)();
+  window.$this = new (#{RailsScript.app_namespace}.#{ controller_path.split(/\/|_/).map(&:capitalize).join('') } || #{RailsScript.app_namespace}.Base)();
   if (typeof $this.beforeAction === 'function') {
     $this.beforeAction("#{action_name}");
   }
@@ -18,8 +18,8 @@ Utility.RailsVars = #{@to_javascript.nil? ? '{}' : @to_javascript.to_json};
     $this.afterAction("#{action_name}");
   }
 })();
-RUBY
+      RUBY
     end
 
   end
-end
+end

data/lib/rails_script/version.rb

@@ -1,3 +1,3 @@
 module RailsScript
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/lib/rails_script.rb

@@ -4,4 +4,10 @@ require 'rails_script/to_javascript'
 require 'rails_script/railtie' if defined?(Rails)
 
 module RailsScript
+  mattr_accessor :app_namespace
+  @@app_namespace = 'App'
+  
+  def self.config
+    yield self
+  end
 end

metadata

@@ -1,61 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: rails_script
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Kevin Pheasey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   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
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.0.0
 description: Rails Script is a Rails-centric, object oriented, featherweight framework
@@ -68,7 +68,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -88,6 +88,7 @@ files:
 - lib/generators/rails_script/install/templates/base.js.coffee
 - lib/generators/rails_script/install/templates/elements/.keep
 - lib/generators/rails_script/install/templates/global.js.coffee
+- lib/generators/rails_script/install/templates/rails_script.rb
 - lib/generators/rails_script/install/templates/utilities/.keep
 - lib/generators/rails_script/utility/USAGE
 - lib/generators/rails_script/utility/templates/javascript.js.coffee
@@ -109,17 +110,17 @@ 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.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Rails-centric, object oriented, featherweight framework for writting CoffeeScript