happy_place 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a0ca9961aa7ce72e1430811b7ddc2fde64b43b4
-  data.tar.gz: ce2bcc45125449f60a1fba8bb293286cce344eb2
+  metadata.gz: 056e62b5797b23e69b1e0cae4158020d0aee4d4a
+  data.tar.gz: e47b08f4ee4d10d4b25c607a71110621a13550b9
 SHA512:
-  metadata.gz: cee773a6407f2021bdab9608ab0409adb95290839802de7a76fc80caf7de299839ecbc7130ef0f1b3d97abe66d99191f0f2eeab6181ecad3b2e837760dc3f9e2
-  data.tar.gz: e7615e937d451b6c695cfb698c180223a61e71892b6fd5c40ce65de7d399612fda8d9a5109e83b766313595992db8bb4a0ff06953aa1f7a4bf7287dc10db2804
+  metadata.gz: 3ce1d9a81d9aebb0b26e178e9d0d42cbe7a555f21ef12e751eee2c16d8599fb09a992a00c1c332e40036204daadc3be6639e086b68f131dcda56008cd995372d
+  data.tar.gz: bea28f72651714c95facdc577c3ddfa60d29be862e1679dae435b5e4ac1e4fd20dfcf1a473b5acdf78cac06b7305b0bbcc220d4c8d678db0ee7f972f761292a2

data/README.md

@@ -1,13 +1,28 @@
-# HappyPlace
+happy_place
+============
+| Project                 |  Gem Release      |
+|------------------------ | ----------------- |
+| Gem name                |  happy_place      |
+| License                 |  [MIT](LICENSE.txt)   |
+| Version                 |  [![Gem Version](https://badge.fury.io/rb/happy_place.png)](http://badge.fury.io/rb/happy_place) |
+| Continuous Integration  |  [![Build Status](https://travis-ci.org/mfpiccolo/happy_place.png?branch=master)](https://travis-ci.org/mfpiccolo/happy_place)
+| Test Coverage           |  [![Coverage Status](https://coveralls.io/repos/mfpiccolo/happy_place/badge.png?branch=master)](https://coveralls.io/r/mfpiccolo/happy_place?branch=coveralls)
+| Grade                   |  [![Code Climate](https://codeclimate.com/github/mfpiccolo/happy_place.png)](https://codeclimate.com/github/mfpiccolo/happy_place)
+| Dependencies            |  [![Dependency Status](https://gemnasium.com/mfpiccolo/happy_place.png)](https://gemnasium.com/mfpiccolo/happy_place)
+| Homepage                |  [http://mfpiccolo.github.io/happy_place][homepage] |
+| Documentation           |  [http://rdoc.info/github/mfpiccolo/happy_place/frames][documentation] |
+| Issues                  |  [https://github.com/mfpiccolo/happy_place/issues][issues] |
 
-TODO: Write a gem description
+## Description
+
+A happy place for javascript in Rails
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'happy_place'
+gem "happy_place"
 ```
 
 And then execute:
@@ -18,14 +33,244 @@ Or install it yourself as:
 
     $ gem install happy_place
 
-## Usage
+## Features
+happy_place adds a js method to your controller.  This method accepts the following keyword arguments:
+
+`js_class:` String name of the js class that you want to user
+
+`function:` Sting of the name of the function you would like to call
+
+`partial:` String of the partial name and path that you would like to render
+
+`args:` Hash of arguments that you would like to be available in your js function
+
+Both partial and keys passed from args will be available in your js function by accessing the object passed in.
+
+```ruby
+class ExampleContorller
+  def index
+    @examples = Example.all
+
+    respond_to do |format|
+      format.js {
+        js(js_class: "ExampleClass",
+           function: "doSomething",
+           partial:  "some_partial",
+           args:     {first_id: @examples.first.id}
+        )
+      }
+      format.html
+    end
+  end
+end
+```
+
+```coffeescript
+class this.ExampleClass
+  constructor: ->
+
+  @doSomething: (args) ->
+    html_to_append = args.partial
+    first_id = args.first_id
+    alert(html_to_append)
+    alert(first_id)
+```
+
+happy_place will infer the js_class and function name if you name it the same as your controller and action.
+
+```ruby
+class ExampleContorller
+  def index
+    @examples = Example.all
+
+    respond_to do |format|
+      format.js {
+        js(
+           partial:  "some_partial",
+           args:     {first_id: @examples.first.id}
+        )
+      }
+      format.html
+    end
+  end
+end
+```
+
+```coffeescript
+class this.ExampleController
+  constructor: ->
+
+  @index: (args) ->
+    html_to_append = args.partial
+    first_id = args.first_id
+    alert(html_to_append)
+    alert(first_id)
+```
+
+If your controller action is only ever going to be hit by one format type or you want the same js to run for both html or js formats then you don't need the responds to and you can use the js method directly in the action definition.
+
+Also if you do not need to pass along args or a partial then you can simply call js
+
+```ruby
+class ExampleContorller
+  def index
+    @examples = Example.all
+
+    js
+  end
+end
+```
+```coffeescript
+class this.ExampleController
+  constructor: ->
+
+  @index: ->
+    alert "Huzza!)
+```
+
+## Naming and Directory Structure
+Technically you can put your code anywhere you want but to make it to your happy place you should follow the naming and directory structure used by rails.
 
-TODO: Write usage instructions here
+If you are adding code that is conroller and action specific, then add a directory called controllers in your `app/assets/javascripts` directory.  If your controllers are namespaced then namespace them just like you do in your rails controllers.  Here is an example of a namespaced coffee class:
+
+```coffeescript
+# app/assets/javascripts/controllers/admin/special/orders_controller
+this.Admin or= {};
+Admin.Special or= {};
+
+class this.Admin.Special.OrdersController
+  constructor: ->
+
+  @index: (args) ->
+    alert("Do some js stuff here...")
+```
+
+Make note of the or=.  This is to make sure that you don't overwrite the js object if it already exists.
+
+Use this same naming and directory structure for all your js.  If you are creating service objects then put them in `app/assets/javascripts/services`
+
+Remember to add your paths to the manifest so sprockets can load them:
+
+```
+//= require_tree ./controllers
+//= require_tree ./services
+```
+
+Or require them explicitly:
+
+`//= require controllers/admin/special/orders_controller`
+
+
+## Example Usecases
+
+### Stop using js views after remote actions!
+
+Lets say you have a blog where you can see a list of posts. (Imagine that!)  You use the Posts#index to display this and it is loaded noramally with :html.
+
+```html
+<!-- posts/index.html.erb -->
+<div class="posts-table">
+    <%= render partial: "posts_table" %>
+</div>
+```
+
+```html
+<!-- posts/_posts_table.html.erb -->
+<table>
+  <thead>
+    <tr>
+      <th>ID</th>
+      <th>Name</th>
+      <th>Description</th>
+      <th>Content</th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @posts.each do |p| %>
+      <tr>
+        <td><%= p.id %></td>
+        <td><%= p.name %></td>
+        <td><%= p.description %></td>
+        <td><%= p.state.humanize.titlecase %></td>
+        <td class="button-column">
+          <%= link_to post_path(p) %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+```
+
+However you want to be able to updat the posts table with a filter that uses ajax.  Normally, you would create view of `views/posts/index.coffee` with the following code:
+
+```coffee
+# views/posts/index.coffee
+$(".posts-table).html("""<%=j render(partial: "/posts_table", posts: @posts ) %>""");
+```
+
+I really do not like this patern.  This leaves your you javascript spread out all over your application and it is hard to keep track your apps workflow.
+
+Here is my happy place for this
+
+Step 1.  Add the gem to gemfile and bundle
+
+Step 2. In the controller action you are interested in handling with js:
+
+```ruby
+class PostsController
+  def index
+    @posts = Posts.all
+
+    respond_to do |format|
+      format.js { js partial: "posts" }
+      format.html
+    end
+  end
+end
+```
+
+Step 3.  in `app/assets/javascripts/controllers/posts_controller.coffee`
+
+```ruby
+class this.PostsController
+  constructor: ->
+
+  @index: (args) ->
+    $(".posts_table").html(args.partial);
+```
+
+Step 4.  Add `assets/controllers` to your manifest application.js
+
+```
+//= require_tree ./controllers
+```
+
+Step 5.  Rejoice!
+
+## Donating
+Support this project and [others by mfpiccolo][gittip-mfpiccolo] via [gittip][gittip-mfpiccolo].
+
+[gittip-mfpiccolo]: https://www.gittip.com/mfpiccolo/
+
+## Copyright
+
+Copyright (c) 2014 Mike Piccolo
+
+See [LICENSE.txt](LICENSE.txt) for details.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/happy_place/fork )
+1. Fork it ( http://github.com/mfpiccolo/happy_place/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Create new Pull Request
+
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/e1a155a07163d56ca0c4f246c7aa8766 "githalytics.com")](http://githalytics.com/mfpiccolo/happy_place)
+
+[license]: https://github.com/mfpiccolo/happy_place/MIT-LICENSE
+[homepage]: http://mfpiccolo.github.io/happy_place
+[documentation]: http://rdoc.info/github/mfpiccolo/happy_place/frames
+[issues]: https://github.com/mfpiccolo/happy_place/issues
+

data/lib/happy_place/controller.rb

@@ -13,22 +13,22 @@ module HappyPlace
     # end
 
     # instance methods to go on every controller go here
-    def js(js_class: nil, method: nil, partial: nil)
+    def js(js_class: nil, function: nil, partial: nil, args: {})
       return unless [:js, :html].include?(request.format.to_sym)
 
       js_class ||= self.class.name.gsub("::", ".")
-      method ||= action_name
+      function ||= action_name
 
       if partial.present?
         appendable = (render_to_string partial: partial).gsub("\n", "")
-        arg = "('#{appendable}');"
+        built_args = "({" + (["partial: '#{appendable}'"] + hash_to_js_args(args)).join(", ") + "});"
       else
-        arg = "()"
+        built_args = "({" + hash_to_js_args(args).join(", ") + "});"
       end
 
-      class_method = [js_class, method].join(".")
+      class_function = [js_class, function].join(".")
       if request.format.to_sym == :js
-        render js: class_method + arg
+        render js: class_function + built_args
       elsif request.format.to_sym == :html
         render
         response_body = response.body
@@ -38,13 +38,22 @@ module HappyPlace
           before_body = response_body[0, before_body_end_index].html_safe
           after_body = response_body[before_body_end_index..-1].html_safe
 
-          response.body = before_body + clean_script(class_method, arg).html_safe + after_body
+          response.body = before_body + clean_script(class_function, built_args).html_safe + after_body
         end
       end
     end
 
-    def clean_script(class_method, arg)
-      "<script type='application/javascript'>jQuery(document).ready(function($) {" + render_to_string(js: class_method + arg) + "});</script>"
+    def clean_script(class_function, args)
+      "<script type='application/javascript'>jQuery(document).ready(function($) {" + render_to_string(js: class_function + args) + "});</script>"
+    end
+
+    def hash_to_js_args(args)
+      js_args = []
+
+      args.each_pair do |k, v|
+        js_args << (k.to_s + ": " + v.to_s)
+      end
+      js_args
     end
 
   end

data/lib/happy_place/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: happy_place
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mike Piccolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails