spine-rails 0.0.4 → 0.0.5

data/README.md

@@ -0,0 +1,121 @@
+# Spine-Rails
+
+Easily setup and use [Spine](http://spinejs.com) with Rails 3.1.
+
+## Rails 3.1 setup
+
+This gem requires the use of [Rails 3.1](http://rubyonrails.org), [CoffeeScript](http://jashkenas.github.com/coffee-script/) and the new Rails asset pipeline provided by [Sprockets](http://getsprockets.org).
+
+This gem does two things:
+
+* Adds Spine to the asset pipeline, so you can easily require it in your applications: `//= require spine`
+    
+* Adds some Spine generators, so you can easily create Spine Models, Views and Controllers.
+
+For versions of Rails less than 3.1, it only provides the generator to install JavaScript file into public directory. 
+
+### Installation
+
+In your Gemfile, add this line:
+
+    gem "spine-rails"
+  
+Then run the following commands:
+
+    bundle install
+    
+    rails generate spine:new
+
+### Layout and namespacing
+
+Running `rails g spine:new` will create the following directory structure:
+  
+    app/assets/javascripts/app/models/
+    app/assets/javascripts/app/views/
+    app/assets/javascripts/app/controllers/
+    app/assets/javascripts/app/index.coffee
+    
+By default your application will be namespaced by the `app` directory. You can specify a different namespace with the `--app` option:
+
+    rails g spine:new --app foo_bar
+    
+Use the top-level level `index.coffee` file to setup namespacing and initial controller instantiation.
+
+## Generators
+
+spine-rails provides three simple generators to help you get started:
+
+### Model
+
+    rails g spine:model User email username full_name
+    
+This generator creates a very minimal model inside `app/assets/javascript/models`. You can optionally provide a list of attributes for the model.
+
+### Controller
+    
+    rails g spine:controller Users
+    
+This generator creates a minimal `Users` controller in `app/assets/javascripts/controllers` to get you started. 
+
+### View
+
+    rails g spine:view users/index
+    
+This generates creates blank Spine views in the `app/assets/javascripts/views/users` directory. 
+
+The generator will create views in `hamljs`, `eco` or `ejs` format, depending on which gems are availale:
+
+- [eco](https://github.com/sstephenson/eco) - will use ECO templates
+- [rub-haml-js](https://github.com/dnagir/ruby-haml-js) - will use HAMLJS templates
+- otherwise, EJS templates will be used
+
+## Example Usage
+
+Created a new Rails 3.1 application called `blog`.
+
+    rails new blog
+
+Edit your Gemfile and add
+
+    gem 'spine-rails'
+
+Install the gem and generate resource.
+
+    bundle install
+    
+    rails g scaffold Post title:string content:string
+    rake db:migrate
+    
+    rails g spine:new
+    rails g spine:model Post title content
+    rails g spine:controllers Posts
+
+You now have the default Spine data structures available to work with.
+
+Next navigate to [http://localhost:3000/posts](http://localhost:3000/posts), and open up the JavaScript console in the browser.
+
+Now you can use Spine:
+
+    // Sends an AJAX POST to the server
+    var post = App.Post.create({
+      title: 'Hello World!', 
+      content: 'Spine & Rails, sitting in a tree!'
+    }); 
+
+    // => ID returned from Rails
+    post.id; 
+    
+    // Sends AJAX PUT to the server
+    post.updateAttributes({title: 'Goodbye'});
+    
+Reload the page, then:
+
+    App.Post.fetch(); // Fetch all posts
+    
+    App.Post.first().content;
+    
+For more information on how to integrate Spine with Rails, please see the [Rails guide](http://spinejs.com/docs/rails).
+
+## Attributions
+
+This plugin was made by [Alex MacCaw](http://alexmaccaw.co.uk) with major contributions from [Dmytrii Nagirniak](https://github.com/dnagir). It's under the same license as [Spine](http://spinejs.com) (MIT).

data/app/assets/javascripts/spine.js

@@ -395,20 +395,16 @@
       return rec && rec.constructor === this.constructor && (rec.id === this.id || (_ref = this.id, __indexOf.call(rec.ids, _ref) >= 0) || (_ref2 = rec.id, __indexOf.call(this.ids, _ref2) >= 0));
     };
     Model.prototype.save = function() {
-      var error;
+      var error, record;
       error = this.validate();
       if (error) {
         this.trigger('error', error);
         return false;
       }
       this.trigger('beforeSave');
-      if (this.newRecord) {
-        this.create();
-      } else {
-        this.update();
-      }
+      record = this.newRecord ? this.create() : this.update();
       this.trigger('save');
-      return this;
+      return record;
     };
     Model.prototype.updateAttribute = function(name, value) {
       this[name] = value;
@@ -474,7 +470,8 @@
       records[this.id].load(this.attributes());
       clone = records[this.id].clone();
       clone.trigger('update');
-      return clone.trigger('change', 'update');
+      clone.trigger('change', 'update');
+      return clone;
     };
     Model.prototype.create = function() {
       var clone, records;
@@ -487,7 +484,8 @@
       records[this.id] = this.dup(false);
       clone = records[this.id].clone();
       clone.trigger('create');
-      return clone.trigger('change', 'create');
+      clone.trigger('change', 'create');
+      return clone;
     };
     Model.prototype.bind = function(events, callback) {
       var binder, unbinder;
@@ -684,7 +682,7 @@
   if (typeof module !== "undefined" && module !== null) {
     module.exports = Spine;
   }
-  Spine.version = '1.0.0';
+  Spine.version = '1.0.3';
   Spine.isArray = isArray;
   Spine.isBlank = isBlank;
   Spine.$ = $;

data/app/assets/javascripts/spine/ajax.js

@@ -57,7 +57,10 @@
     Base.prototype.defaults = {
       contentType: 'application/json',
       dataType: 'json',
-      processData: false
+      processData: false,
+      headers: {
+        'X-Requested-With': 'XMLHttpRequest'
+      }
     };
     Base.prototype.ajax = function(params, defaults) {
       return $.ajax($.extend({}, this.defaults, defaults, params));
@@ -203,15 +206,17 @@
   };
   Model.Ajax = {
     extended: function() {
-      this.change(function(record, type) {
-        return record.ajax()[type]();
-      });
-      this.fetch(function() {
-        var _ref;
-        return (_ref = this.ajax()).fetch.apply(_ref, arguments);
-      });
+      this.fetch(this.ajaxFetch);
+      this.change(this.ajaxChange);
       this.extend(Extend);
       return this.include(Include);
+    },
+    ajaxFetch: function() {
+      var _ref;
+      return (_ref = this.ajax()).fetch.apply(_ref, arguments);
+    },
+    ajaxChange: function(record, type) {
+      return record.ajax()[type]();
     }
   };
   Model.Ajax.Methods = {
@@ -224,4 +229,4 @@
   if (typeof module !== "undefined" && module !== null) {
     module.exports = Ajax;
   }
-}).call(this);
+}).call(this);

data/app/assets/javascripts/spine/rails.js

@@ -0,0 +1,3 @@
+Spine.Controller.include({
+  view: function(name) { return JST['views/' + name]; }
+});

data/lib/generators/spine/controller/controller_generator.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'spine/generators'
+
+module Spine
+  module Generators
+    class ControllerGenerator < Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Generate a Spine controller"
+
+      def create_controller
+        template "controller.coffee.erb", "app/assets/javascripts/#{app_name}/controllers/#{file_name}.coffee"
+      end
+    end
+  end
+end

data/lib/generators/spine/controller/templates/controller.coffee.erb

@@ -0,0 +1,10 @@
+class <%= app_class %>.<%= class_name %> extends Spine.Controller
+  # elements:
+  #   '.items': items
+  # 
+  # events:
+  #   'click .item': 'itemClick'
+
+  constructor: ->
+    super
+    # ...

data/lib/generators/spine/model/model_generator.rb

@@ -0,0 +1,17 @@
+require 'rails'
+require 'spine/generators'
+
+module Spine
+  module Generators
+    class ModelGenerator < Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Generate a Spine model with configured fields"
+
+      argument :fields, :desc => 'List of model attributes', :type => :array, :banner => 'field1 field2'
+
+      def create_model
+        template "model.coffee.erb", "app/assets/javascripts/#{app_name}/models/#{file_name}.coffee"
+      end
+    end
+  end
+end

data/lib/generators/spine/model/templates/model.coffee.erb

@@ -0,0 +1,3 @@
+class <%= app_class %>.<%= class_name %> extends Spine.Model
+  @configure '<%= class_name %>', <%= fields.map {|f| "\'#{f}\'" }.join(', ') %>
+  @extend Spine.Model.Ajax

data/lib/generators/spine/new/new_generator.rb

@@ -0,0 +1,45 @@
+require 'rails'
+
+module Spine
+  module Generators
+    class NewGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+  
+      desc "This generator installs Spine #{Spine::Rails::SPINE_VERSION} as part of assets pipeline"
+      
+      class_option :app, :type => :string, :default => "app", :desc => "app name"
+      
+      def app_name
+        options[:app]
+      end
+      
+      def app_class
+        app_name.camelize
+      end
+          
+      def create_dir_layout
+        %W{models views controllers lib}.each do |dir|
+          empty_directory "app/assets/javascripts/#{app_name}/#{dir}" 
+          create_file "app/assets/javascripts/#{app_name}/#{dir}/.gitkeep"
+        end
+      end
+    
+      def create_app_file
+        template "index.coffee.erb", "app/assets/javascripts/#{app_name}/index.coffee"
+      end
+     
+      def add_spine_app_to_application
+        source  = "app/assets/javascripts/application.js"
+        content = File.read(source)
+        
+        if content.include?("//= require_tree .")
+          inject_into_file source, :before => "//= require_tree ." do
+            "//= require #{app_name}\n"
+          end
+        else
+          append_file source, "\n//= require #{app_name}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/spine/new/templates/index.coffee.erb

@@ -0,0 +1,25 @@
+#= require json2
+#= require jquery
+#= require spine
+#= require spine/manager
+#= require spine/ajax
+#= require spine/route
+#= require spine/rails
+
+#= require_tree ./lib
+#= require_self
+#= require_tree ./models
+#= require_tree ./controllers
+#= require_tree ./views
+
+class <%= app_class %> extends Spine.Controller
+  constructor: ->
+    super
+    
+    # Initialize controllers:
+    #  @append(@items = new <%= app_class %>.Items)
+    #  ...
+    
+    Spine.Route.setup()
+
+window.<%= app_class %> = <%= app_class %>

data/lib/generators/spine/view/templates/view.eco.erb

@@ -0,0 +1,2 @@
+<div class="<%= file_name %>">
+</div>

data/lib/generators/spine/view/templates/view.ejs.erb

@@ -0,0 +1,2 @@
+<div class="<%= file_name %>">
+</div>

data/lib/generators/spine/view/templates/view.hamljs.erb

@@ -0,0 +1,2 @@
+.<%= file_name %>
+  

data/lib/generators/spine/view/view_generator.rb

@@ -0,0 +1,24 @@
+require 'rails'
+require 'spine/generators'
+
+module Spine
+  module Generators
+    class ViewGenerator < Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Generate a Spine view, eg: posts/index"
+
+      # rails g spine:view Users index edit show
+      def create_views
+        view_format = if defined?(::Eco)
+          'eco'
+        elsif defined?(::RubyHamlJs)
+          'hamljs'
+        else
+          'ejs'
+        end
+
+        template "view.#{view_format}.erb", "app/assets/javascripts/#{app_name}/views/#{file_name}.jst.#{view_format}"
+      end
+    end
+  end
+end

data/lib/spine/generators.rb

@@ -0,0 +1,19 @@
+module Spine
+  module Generators
+    class Base < ::Rails::Generators::NamedBase
+      class_option :app, :type => :string, :default => "app", :desc => "app name"
+      
+      def class_name
+        (class_path + [file_name]).map!{ |m| m.camelize }.join('')
+      end
+      
+      def app_name
+        options[:app]
+      end
+      
+      def app_class
+        app_name.camelize
+      end
+    end
+  end
+end

data/lib/spine/rails/version.rb

@@ -1,6 +1,6 @@
 module Spine
   module Rails
-    VERSION = "0.0.4"
-    SPINE_VERSION = "1.0.2"
+    VERSION = "0.0.5"
+    SPINE_VERSION = "1.0.3"
   end
 end

data/spine-rails.gemspec

@@ -14,10 +14,9 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "spine-rails"
 
-  s.add_dependency "actionpack", "~> 3.1.0"
-  s.add_development_dependency "bundler", "~> 1.0.0"
-  s.add_development_dependency "rails",   "~> 3.0"
-
+  s.add_dependency             "rails", ">= 3.1.0"
+  s.add_development_dependency "bundler"
+  
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").select{|f| f =~ /^bin/}
   s.require_path = 'lib'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spine-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,41 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000Z
+date: 2011-10-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: &70334460548580 !ruby/object:Gem::Requirement
+  name: rails
+  requirement: &70146319394780 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70334460548580
+  version_requirements: *70146319394780
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70334460548120 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *70334460548120
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70334460547660 !ruby/object:Gem::Requirement
+  requirement: &70146319394400 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334460547660
+  version_requirements: *70146319394400
 description: This gem provides Spine for your Rails 3 application.
 email:
 - info@eribium.org
@@ -54,6 +43,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - app/assets/javascripts/json2.js
 - app/assets/javascripts/spine.js
@@ -61,12 +51,23 @@ files:
 - app/assets/javascripts/spine/list.js
 - app/assets/javascripts/spine/local.js
 - app/assets/javascripts/spine/manager.js
+- app/assets/javascripts/spine/rails.js
 - app/assets/javascripts/spine/relation.js
 - app/assets/javascripts/spine/route.js
 - app/assets/javascripts/spine/tabs.js
 - app/assets/javascripts/spine/tmpl.js
-- lib/generators/spine/install/install_generator.rb
+- lib/generators/spine/controller/controller_generator.rb
+- lib/generators/spine/controller/templates/controller.coffee.erb
+- lib/generators/spine/model/model_generator.rb
+- lib/generators/spine/model/templates/model.coffee.erb
+- lib/generators/spine/new/new_generator.rb
+- lib/generators/spine/new/templates/index.coffee.erb
+- lib/generators/spine/view/templates/view.eco.erb
+- lib/generators/spine/view/templates/view.ejs.erb
+- lib/generators/spine/view/templates/view.hamljs.erb
+- lib/generators/spine/view/view_generator.rb
 - lib/spine-rails.rb
+- lib/spine/generators.rb
 - lib/spine/rails.rb
 - lib/spine/rails/engine.rb
 - lib/spine/rails/version.rb

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

@@ -1,18 +0,0 @@
-require 'rails'
-
-module Spine
-  module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-
-      desc "This generator installs Spine #{Spine::Rails::SPINE_VERSION}"
-
-      source_root File.expand_path('../../../../../app/assets/javascripts', __FILE__)
-
-      def copy_spine
-        say_status("copying", "Spine (#{Spine::Rails::SPINE_VERSION})", :green)
-        copy_file "spine.js", "public/javascripts/spine.js"
-        copy_file "spine.min.js", "public/javascripts/spine.min.js"
-      end
-    end
-  end
-end if ::Rails.version < "3.1"