RubyGems - extjs_scaffold - Versions diffs - 0.1.1 - Mend

extjs_scaffold 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (101) hide show

data/.gitignore ADDED Viewed

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+tmp/*
+resources/*
+.DS_Store

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --color

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in extjs_scaffold.gemspec
+gemspec

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2012 Mark H Winkler
+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 ADDED Viewed

@@ -0,0 +1,80 @@
+# ExtjsScaffold
+Rails 3.1 Scaffold generator for Extjs 4
+## Usage
+### Install
+1) Install Sencha Extjs 4 into public
+	public/extjs
+2) Add Extjs to app/views/layouts/application.html.erb
+	<html>
+	<head>
+	  <title>TestApp</title>
+	  <%= stylesheet_link_tag    "/extjs/resources/css/ext-all.css" %>
+	  <%= stylesheet_link_tag    "application" %>
+	  <%= javascript_include_tag "/extjs/ext-all-debug.js" %>
+	  <%= javascript_include_tag "application" %>
+	  <%= csrf_meta_tags %>
+	</head>
+	<body>
+	<%= yield %>
+	</body>
+	</html>
+3) Add Extjs MVC structure app/assets/javascripts/application.js
+		//= require_self
+		//= require_tree ./ux
+		//= require_tree ./util
+		//= require_tree ./model
+		//= require_tree ./store
+		//= require_tree ./view
+		//= require_tree ./controller
+		//= require_tree .
+4) Run the install generator
+	rails generate extjs_scaffold:install
+Which will create an Extjs application file and the scaffold ux files. By default the application file and the application name are set to the rails app name.
+These can be customized using the --file-name and --app-name class options
+	rails generate extjs_scaffold:install --file-name=ExtjsApp --app-name=TestApp
+	or
+	rails generate extjs_scaffold:install -n=ExtjsApp -a=TestApp
+### Scaffold
+	rails generate scaffold extjs_scaffold:scaffold widget name:string
+Class Options
+If the file or app name were customized during the install, they must be passed into the scaffold generator:
+	rails generate extjs_scaffold:scaffold widget name:string -n=ExtjsApp -a=TestApp
+Reference field lookups default to a 'name' field in the parent table. This can be customized by setting the --reference_fields option:
+	rails generate extjs_scaffold:scaffold widget category:references name:string --reference_fields category:category_type
+	Which would look for a 'category_type' field in the category table
+Pagination defaults to Kaminari.  To use Will Paginate, set the --pagination option:
+	rails generate extjs_scaffold:scaffold widget name:string --pagination=will_paginate
+Views support erb (default) and haml
+Controller tests for TestUnit and Rspec are generated
+ORM is generated using Rails::Generators::ScaffoldGenerator and then injected with additional methods

data/Rakefile ADDED Viewed

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+require "bundler/gem_tasks"
+require "rubygems"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rake'
+require 'rake/rdoctask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ExtjsScaffold'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/extjs_scaffold.gemspec ADDED Viewed

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "extjs_scaffold/version"
+Gem::Specification.new do |s|
+  s.name        = "extjs_scaffold"
+  s.version     = ExtjsScaffold::VERSION
+  s.authors     = ["mwinkler"]
+  s.email       = ["mhwinkler@gmail.com"]
+  s.homepage    = "https://github.com/mojomaze/extjs_scaffold"
+  s.summary     = "Scaffold Generator for Rails 3.1 and Extjs 4"
+  s.description = "Scaffold Generator for Rails 3.1 and Sencha Extjs 4"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec", "~> 2.7.0"
+  s.add_development_dependency "rspec-rails", "~> 2.7.0"
+  s.add_development_dependency "generator_spec"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "cucumber-rails"
+  s.add_development_dependency "aruba", "< 0.4.7"
+  s.add_runtime_dependency "rails", "~> 3.1.0"
+end

data/features/scaffold_generator.feature ADDED Viewed

@@ -0,0 +1,124 @@
+Feature: Generate Extjs Install and Scaffold
+  In order to use extjs as a scaffold replacement
+  As a user of Rails3 and extjs4
+	I would like to generate an extjs scaffold
+	Scenario: Generate ExtJs Scaffold
+    When I run `rails new test_app`
+		And I cd to "test_app"
+    Then the following files should exist:
+			| Gemfile |
+      | app/assets/javascripts/application.js |
+			| app/assets/stylesheets/application.css |
+		And I append to "Gemfile" with:
+			"""
+			gem "haml"
+			gem "kaminari"
+			gem "extjs_renderer", "~> 0.1.0"
+			gem 'extjs_scaffold', :path => '../../../'
+			"""
+		And I overwrite "app/views/layouts/application.html.erb" with:
+			"""
+			<!DOCTYPE html>
+			<html>
+			<head>
+			  <title>TestApp</title>
+			  <%= stylesheet_link_tag    "/extjs/resources/css/ext-all.css" %>
+			  <%= stylesheet_link_tag    "application" %>
+			  <%= javascript_include_tag "/extjs/ext-all-debug.js" %>
+			  <%= javascript_include_tag "application" %>
+			  <%= csrf_meta_tags %>
+			</head>
+			<body>
+			<%= yield %>
+			</body>
+			</html>
+			"""
+		And I overwrite "app/assets/javascripts/application.js" with:
+			"""
+			//= require_self
+			//= require_tree ./ux
+			//= require_tree ./util
+			//= require_tree ./model
+			//= require_tree ./store
+			//= require_tree ./view
+			//= require_tree ./controller
+			//= require_tree .
+			"""
+		And I install extjs in "test_app"
+		Then the following files should exist:
+			| public/extjs/bootstrap.js |
+			| public/extjs/ext-all-debug.js |
+		And I run `bundle install`
+		Then the output should contain:
+		"""
+		Your bundle is complete!
+		"""
+		And I run `rails g extjs_scaffold:install`
+		Then the following files should exist:
+			| app/assets/javascripts/TestApp.js |
+		And I run `rails g extjs_scaffold:scaffold category name:string`
+			Then the following files should exist:
+				| app/assets/javascripts/controller/Categories.js |
+				| app/controllers/categories_controller.rb |
+				| app/models/category.rb |
+				| app/views/categories/index.html.erb |
+				| test/functional/categories_controller_test.rb |
+		And I run `rails g extjs_scaffold:scaffold product category:references name:string`
+			Then the following files should exist:
+				| app/assets/javascripts/controller/Products.js |
+				| app/controllers/products_controller.rb |
+				| app/models/product.rb |
+				| app/views/products/index.html.erb |
+				| test/functional/products_controller_test.rb |
+		And I append to "Gemfile" with:
+			"""
+			gem "rspec", "~> 2.7.0"
+		  gem "rspec-rails", "~> 2.7.0"
+			"""
+		And I run `bundle install`
+		Then the output should contain:
+		"""
+		Your bundle is complete!
+		"""
+		And I run `rails g rspec:install`
+		Then the following files should exist:
+			| spec/spec_helper.rb |
+		And I run `rails g extjs_scaffold:scaffold widget name:string sku:string in_stock:boolean price:decimal last_received_on:date --template_engine=haml`
+		Then the following files should exist:
+			| app/assets/javascripts/controller/Widgets.js |
+			| app/controllers/widgets_controller.rb |
+			| app/models/widget.rb |
+			| app/views/widgets/index.html.haml |
+			| spec/controllers/widgets_controller_spec.rb |
+		And I run `rails g extjs_scaffold:scaffold part widget:references name:string quantity:integer --template_engine=haml --reference-fields widget:sku`
+		Then the following files should exist:
+			| app/assets/javascripts/controller/Parts.js |
+			| app/controllers/parts_controller.rb |
+			| app/models/part.rb |
+			| app/views/parts/index.html.haml |
+			| spec/controllers/parts_controller_spec.rb |
+		And I run `rake db:migrate`
+		Then the output should contain:
+		"""
+		CreateParts: migrated
+		"""
+		And I run `rake db:test:prepare`
+		And I run `ruby -Itest test/functional/categories_controller_test.rb`
+		Then the output should contain:
+		"""
+		0 failures, 0 errors, 0 skips
+		"""
+		And I run `ruby -Itest test/functional/products_controller_test.rb`
+		Then the output should contain:
+		"""
+		0 failures, 0 errors, 0 skips
+		"""
+		And I run `rspec spec`
+		Then the output should contain:
+		"""
+		0 failures
+		"""

data/features/step_definitions/aruba_ext_steps.rb ADDED Viewed

@@ -0,0 +1,6 @@
+Given /^I install extjs in "([^"]*)"$/ do |app_name|
+  src = File.expand_path('../../../resources/extjs', __FILE__ )
+  dest = File.expand_path("../../../#{@dirs.first}/#{app_name}/public", __FILE__ )
+  FileUtils.cp_r src, dest
+end

data/features/support/setup.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+Before do
+  @aruba_timeout_seconds = 30
+end

data/lib/extjs_scaffold.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require "extjs_scaffold/version"

data/lib/extjs_scaffold/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module ExtjsScaffold
+  VERSION = "0.1.1"
+end

data/lib/generators/extjs_scaffold.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require "rails/generators/named_base"
+module ExtjsScaffold
+  module Generators
+    class Base < Rails::Generators::NamedBase
+      def self.source_root
+        @_extjs_scaffold_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'extjs_scaffold', generator_name, 'templates'))
+      end
+      def self.rails_app_name
+        Rails.root.to_s.split('/').last.titlecase.split.join
+      end
+    end
+  end
+end

data/lib/generators/extjs_scaffold/install/USAGE ADDED Viewed

@@ -0,0 +1,28 @@
+Description:
+    Installs Ext Application file and ux files needed for scaffold
+Example:
+    rails new MyCoolApp
+    rails generate extjs_scaffold:install
+    This will create:
+        app/assests/images/extjs_scaffold/add.gif
+        app/assests/images/extjs_scaffold/application_form_edit.png
+        app/assests/images/extjs_scaffold/delete.gif
+        app/assests/images/extjs_scaffold/README.txt
+        app/assests/images/extjs_scaffold/tick.png
+        app/assets/javascripts/MyCoolApp.js
+        app/assets/javascripts/model/ParentCombo.js
+        app/assets/javascripts/util/Format.js
+        app/assets/javascripts/ux/data/Actionable.js
+        app/assets/javascripts/ux/data/Updateable.js
+        app/assets/javascripts/ux/proxy/Rails.js
+        app/assets/javascripts/ux/form/Panel.js
+        app/assets/javascripts/ux/field/ParentCombo.js
+        app/assets/javascripts/ux/field/SearchField.js
+        app/assets/javascripts/ux/grid/Panel.js
+        app/assets/javascripts/ux/toolbar/Scrolling.js
+        app/assets/javascripts/ux/window/EditWindow.js
+        app/assets/javascripts/ux/window/UpdateWindow.js
+        app/assets/stylesheets/extjs_scaffold.css.scss
+        public/images/extjs_scaffold/tick.png

data/lib/generators/extjs_scaffold/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,82 @@
+require 'generators/extjs_scaffold'
+module ExtjsScaffold
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :file_name, :desc => "Name of file used to hold Ext.application",
+                    :aliases => '-n', :default => ExtjsScaffold::Generators::Base.rails_app_name
+      class_option :app_name, :desc => "Name of app used in Ext.application",
+                    :aliases => '-a', :default => ExtjsScaffold::Generators::Base.rails_app_name
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+      def css_and_images
+        copy_file 'extjs_scaffold.css.scss', 'app/assets/stylesheets/extjs_scaffold.css.scss'
+        directory 'images', 'app/assets/images/extjs_scaffold'
+        copy_file 'images/tick.png', 'public/images/extjs_scaffold/tick.png'
+      end
+      def ext_auth_partial
+        copy_file 'ext_auth.html.erb', 'app/views/shared/_ext_auth.html.erb'
+      end
+      def create_application_file
+        empty_directory File.join("app/assets", "javascripts")
+        template 'App.js', File.join('app/assets/javascripts/', app_file_name)
+      end
+      def create_util_file
+        empty_directory File.join("app/assets/javascripts", "util")
+        template 'Format.js', File.join('app/assets/javascripts/util/', 'Format.js')
+      end
+      def create_ux_files
+        empty_directory File.join("app/assets/javascripts", "ux")
+        # data
+        empty_directory File.join("app/assets/javascripts/ux", "data")
+        empty_directory File.join("app/assets/javascripts/ux/data", "proxy")
+        template 'Actionable.js', File.join('app/assets/javascripts/ux/data/', 'Actionable.js')
+        template 'Updateable.js', File.join('app/assets/javascripts/ux/data/', 'Updateable.js')
+        template 'Rails.js', File.join('app/assets/javascripts/ux/data/proxy/', 'Rails.js')
+        # form
+        empty_directory File.join("app/assets/javascripts/ux", "form")
+        empty_directory File.join("app/assets/javascripts/ux/form", "field")
+        template 'FormPanel.js', File.join('app/assets/javascripts/ux/form/', 'Panel.js')
+        template 'ParentComboField.js', File.join('app/assets/javascripts/ux/form/field', 'ParentCombo.js')
+        template 'SearchField.js', File.join('app/assets/javascripts/ux/form/field/', 'SearchField.js')
+        #grid
+        empty_directory File.join("app/assets/javascripts/ux", "grid")
+        template 'GridPanel.js', File.join('app/assets/javascripts/ux/grid/', 'Panel.js')
+        #toolbar
+        empty_directory File.join("app/assets/javascripts/ux", "toolbar")
+        template 'ScrollingToolbar.js', File.join('app/assets/javascripts/ux/toolbar/', 'Scrolling.js')
+        #window
+        empty_directory File.join("app/assets/javascripts/ux", "window")
+        template 'EditWindow.js', File.join('app/assets/javascripts/ux/window/', 'EditWindow.js')
+        template 'UpdateWindow.js', File.join('app/assets/javascripts/ux/window/', 'UpdateWindow.js')
+      end
+      protected
+      def app_file_name
+        #file_name = options.file_name || rails_app_name
+        [options.file_name, :js].compact.join(".")
+      end
+      def app_name
+        options.app_name
+      end
+    end
+  end
+end