spree 0.60.6 → 0.70.0.rc2

data/README.md

@@ -29,28 +29,20 @@ Start by adding the gem to your existing Rails 3.x application's Gemfile
 
 Update your bundle
 
-    bundle install
+    $ bundle install
 
-Then use the install generator to do the basic setup (add Spree to Gemfile, etc.)
+Then use the install generator to do the basic setup
 
-    rails g spree:site
+    $ rails g spree:site
 
-Now its time to install all of the necessary migrations, assets, etc.
+Now you just need to run the new migrations, and setup some basic data
 
-    rake spree:install
-
-If you'd like to also install sample data and images you can follow up the above command with:
-
-    rake spree_sample:install
-
-Now you just need to run the new migrations
-
-    rake db:migrate
-    rake db:seed
+    $ bundle exec rake db:migrate
+    $ bundle exec rake db:seed
 
 If you also want some sample products, orders, etc. to play with you can run the appropriate rake task.
 
-    rake db:sample
+    $ bundle exec rake spree_sample:load
 
 
 Browse Store
@@ -82,49 +74,67 @@ The source code is essentially a collection of gems.  Spree is meant to be run w
 
 3. Create a sandbox rails application for testing purposes (and automatically perform all necessary database setup)
 
-        rake sandbox
+        bundle exec rake sandbox
 
 6. Start the server
 
         cd sandbox
         rails server
 
+Performance
+-----------
+
+You may noticed that your Spree store runs slowly in development mode.  This is a side-effect of how Rails works in development mode which is to continuous reload your Ruby objects on each request.  The introduction of the asset pipeline in Rails 3.1 made default performance in development mode significantly worse.  There are, however, a few tricks to speeding up performance.
+
+You can recompile your assets as follows:
+
+        $ bundle exec rake assets:precompile RAILS_ENV=development
+
+If you want to remove precompiled assets (recommended before you commit to git and push your changes) use the following rake task:
+
+        $ bundle exec rake assets:clean
+
+
+
 Running Tests
 -------------
 
 If you want to run all the tests across all the gems then
 
     $ cd spree
-    $ rake spec     #=> 'this will run spec tests for all the gems'
-    $ rake cucumber #=> 'this will run cucumber tests for all the gems'
-    $ rake          #=> 'this will run both spec and cucumber tests for all the gems'
+    $ bundle exec rake          #=> 'this will run both spec and cucumber tests for all the gems'
 
 Each gem contains its own series of tests, and for each directory, you need to do a quick one-time
 creation of a test application and then you can use it to run the tests.  For example, to run the
 tests for the core project.
 
     $ cd core
-    $ rake test_app
-    $ rake spec
-    $ rake cucumber
-    $ rake          #=> 'this will run both spec and cucumber tests for the gem'
+    $ bundle exec rake test_app
+
+Now you can run just the specs, just the features or everything together
+
+    $ bundle exec rake spec
+    $ bundle exec rake cucumber
+    $ bundle exec rake          #=> 'this will run both spec and cucumber tests for the gem'
+
+If you want to run specs for only a single spec file
 
-    # If you want to run specs for only a single spec file
     $ bundle exec rspec spec/models/state_spec.rb
 
-    # If you want to run a particular line of spec
+If you want to run a particular line of spec
+
     $ bundle exec rspec spec/models/state_spec.rb:7
 
-    # If you want to run a single cucumber feature
-    # bundle exec cucumber features/admin/orders.feature --require features
+If you want to run a single cucumber feature
+
+    $ bundle exec cucumber features/admin/orders.feature --require features
 
-    # If you want to run a particular scenario then include the line number
-    # bundle exec cucumber features/admin/orders.feature:3 --require features
+If you want to run a particular scenario then include the line number
+
+    $ bundle exec cucumber features/admin/orders.feature:3 --require features
 
 
 Contributing
 ------------
 
 Spree is an open source project.  We encourage contributions.  Please see the [contributors guidelines](http://spreecommerce.com/documentation/contributing_to_spree.html) before contributing.
-
-The Github team has also been kind enough to write up some great [documentation](http://help.github.com/pull-requests/) on working with pull requests. Contributions should be performed on [topic branches](http://progit.org/book/ch3-4.html) in your personal forks - just issue your pull requests from there. We're also asking that you continue to log important issues for non-trivial patches in our [lighthouse repository](http://railsdog.lighthouseapp.com/projects/31096-spree). You can just link the pull request in the ticket (and link the ticket in the pull request.)

data/lib/spree.rb

@@ -5,7 +5,4 @@ require 'spree_dash'
 require 'spree_promo'
 require 'spree_sample'
 
-module Spree
-  class Engine < Rails::Engine
-  end
-end
+require 'spree/engine'

data/lib/spree/bin/spree

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'spree/cli'
+require 'active_support/core_ext'
+
+Spree::CLI.start

data/lib/spree/cli.rb

@@ -0,0 +1,52 @@
+require "rubygems"
+require "spree_core/version"
+require "thor"
+require 'spree/extension'
+#require 'spree/application'
+#require 'spree/test'
+
+module Spree
+  class CLI < Thor
+    def self.basename
+      "spree"
+    end
+
+    map "-v"        => "version"
+    map "--version" => "version"
+
+    desc "version", "print the current version"
+    def version
+      shell.say "Spree #{Spree.version}", :green
+    end
+
+    desc "extension NAME", "create a new extension with the given name"
+    method_option "name", :type => :string
+    def extension(name)
+      invoke "spree:extension:generate", [options[:name] || name]
+    end
+
+    #desc "app NAME", "creates a new rails app configured to use Spree"
+    #method_option "name", :type => :string
+    #method_option "sample", :type => :boolean, :default => false
+    #method_option "bootstrap", :type => :boolean, :default => false
+    #method_option "clean", :type => :boolean, :default => false
+    #method_option "dir", :type => :string, :default => '.'
+    #def app(name)
+      #invoke "spree:application:generate", [options[:name] || name, options]
+    #end
+
+    #desc "sandbox", "create a sandbox rails app complete with sample data"
+    #def sandbox(name="sandbox")
+      #invoke "spree:application:generate", [options[:name] || name, {:clean => true, :sample => true,
+                                                                     #:bootstrap => true}]
+    #end
+
+    #desc "test_app", "create a rails app suitable for Spree testing"
+    #method_option "dir", :type => :string, :default => '.'
+    #def test_app(name="test_app")
+      ##invoke "spree:application:generate", [options[:name] || name, {:clean => true, :dir => options[:dir]}]
+      #invoke "spree:test:generate", [options[:dir]]
+    #end
+  end
+end
+

data/lib/spree/engine.rb

@@ -0,0 +1,5 @@
+module Spree
+  class Engine < Rails::Engine
+    engine_name 'spree'
+  end
+end

data/lib/spree/extension.rb

@@ -0,0 +1,77 @@
+module Spree
+  class Extension < Thor
+    include Thor::Actions
+
+    def self.source_root
+      File.dirname(__FILE__) + '/templates/extension'
+    end
+
+    desc "generate NAME", "generate extension"
+    def generate(name)
+
+      class_path = name.include?('/') ? name.split('/') : name.split('::')
+      class_path.map! { |m| m.underscore }
+      self.file_name = 'spree_' + class_path.pop.gsub('spree_', '')
+      self.human_name = name.titleize
+      self.class_name = file_name.classify
+
+      empty_directory file_name
+
+      directory "app", "#{file_name}/app"
+
+      empty_directory "#{file_name}/app/controllers"
+      empty_directory "#{file_name}/app/helpers"
+      empty_directory "#{file_name}/app/models"
+      empty_directory "#{file_name}/app/views"
+      empty_directory "#{file_name}/app/overrides"
+      empty_directory "#{file_name}/config"
+      empty_directory "#{file_name}/db"
+
+      directory "lib", "#{file_name}/lib"
+      directory "script", "#{file_name}/script"
+
+      empty_directory "#{file_name}/spec"
+
+      template "LICENSE", "#{file_name}/LICENSE"
+      template "Rakefile", "#{file_name}/Rakefile"
+      template "README.md", "#{file_name}/README.md"
+      template "gitignore", "#{file_name}/.gitignore"
+      template "extension.gemspec", "#{file_name}/#{file_name}.gemspec"
+      template "Versionfile", "#{file_name}/Versionfile"
+      template "routes.rb", "#{file_name}/config/routes.rb"
+      template "Gemfile", "#{file_name}/Gemfile" unless integrated
+      template "spec_helper.rb.tt", "#{file_name}/spec/spec_helper.rb"
+      template "rspec", "#{file_name}/.rspec"
+
+      if integrated
+        append_to_file(gemfile) do
+          "\ngem '#{file_name}', :path => '#{file_name}'"
+        end
+      end
+    end
+
+    no_tasks do
+      # File/Lib Name (ex. spree_paypal_express)
+      attr_accessor :file_name
+    end
+
+    no_tasks do
+      # Human Readable Name (ex. Paypal Express)
+      attr_accessor :human_name
+    end
+
+    no_tasks do
+      # Class Name (ex. PaypalExpress)
+      attr_accessor :class_name
+    end
+
+    protected
+    def gemfile
+      File.expand_path("Gemfile", Dir.pwd)
+    end
+    # extension is integrated with an existing rails app (as opposed to standalone repository)
+    def integrated
+      File.exist?(gemfile)
+    end
+  end
+end

data/lib/spree/templates/extension/Gemfile

@@ -0,0 +1,22 @@
+source 'http://rubygems.org'
+
+gem 'sqlite3'
+
+group :test do
+  gem 'rspec-rails', '= 2.6.1'
+end
+
+group :cucumber do
+  gem 'cucumber-rails', '1.0.0'
+  gem 'database_cleaner', '= 0.6.7'
+  gem 'nokogiri'
+  gem 'capybara', '1.0.1'
+end
+
+if RUBY_VERSION < "1.9"
+  gem "ruby-debug"
+else
+  gem "ruby-debug19"
+end
+
+gemspec

data/lib/{generators/templates → spree/templates/extension}/LICENSE

@@ -1,14 +1,17 @@
-Redistribution and use in source and binary forms, with or without modification, 
+Copyright (c) <%= Date.today.year %> [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
-    * Redistributions of source code must retain the above copyright notice, 
+    * Redistributions of source code must retain the above copyright notice,
       this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright notice, 
-      this list of conditions and the following disclaimer in the documentation 
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
-    * Neither the name of the Rails Dog LLC nor the names of its 
-      contributors may be used to endorse or promote products derived from this 
-      software without specific prior written permission.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
@@ -20,4 +23,4 @@ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/{generators/templates → spree/templates/extension}/README.md

@@ -9,5 +9,12 @@ Example
 
 Example goes here.
 
+Testing
+-------
+
+Be sure to add the rspec-rails gem to your Gemfile and then create a dummy test app for the specs to run against.
+
+    $ bundle exec rake test app
+    $ bundle exec rspec spec
 
 Copyright (c) <%= Date.today.year %> [name of extension creator], released under the New BSD License

data/lib/spree/templates/extension/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+require 'spree_core/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+Cucumber::Rake::Task.new
+
+task :default => [:spec, :cucumber ]
+
+spec = eval(File.read('<%=file_name%>.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc "Release to gemcutter"
+task :release => :package do
+  require 'rake/gemcutter'
+  Rake::Gemcutter::Tasks.new(spec).define
+  Rake::Task['gem:push'].invoke
+end
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV['LIB_NAME'] = '<%=file_name%>'
+  Rake::Task['common:test_app'].invoke
+end

data/lib/{generators/templates/Versionfile.tt → spree/templates/extension/Versionfile}

@@ -3,7 +3,7 @@
 
 # Examples
 #
-# "0.50.x" => { :branch => "master" }
+# "0.70.x" => { :branch => "master"}
+# "0.60.x" => { :branch => "0-60-stable" }
 # "0.40.x" => { :tag => "v1.0.0", :version => "1.0.0" }
 
-

data/lib/spree/templates/extension/app/assets/javascripts/admin/%file_name%.js

@@ -0,0 +1 @@
+//= require admin/spree_core

data/lib/spree/templates/extension/app/assets/javascripts/store/%file_name%.js

@@ -0,0 +1 @@
+//= require store/spree_core

data/lib/spree/templates/extension/app/assets/stylesheets/admin/%file_name%.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_core
+*/

data/lib/spree/templates/extension/app/assets/stylesheets/store/%file_name%.css

@@ -0,0 +1,3 @@
+/*
+ *= require store/spree_core
+*/

data/lib/{generators/templates/extension.gemspec.tt → spree/templates/extension/extension.gemspec}

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = '<%= file_name %>'
@@ -11,10 +12,12 @@ Gem::Specification.new do |s|
   # s.homepage          = 'http://www.rubyonrails.org'
   # s.rubyforge_project = 'actionmailer'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #s.files         = `git ls-files`.split("\n")
+  #s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_path = 'lib'
   s.requirements << 'none'
 
-  s.add_dependency('spree_core', '>= <%= Spree.version %>')
+  s.add_dependency 'spree_core', '>= <%= Spree.version %>'
+  s.add_development_dependency 'rspec-rails'
 end
+

data/lib/{generators/templates/gitignore.tt → spree/templates/extension/gitignore}

@@ -7,3 +7,4 @@
 tmp
 nbproject
 *.swp
+spec/dummy

data/lib/spree/templates/extension/lib/%file_name%.rb.tt

@@ -0,0 +1,2 @@
+require 'spree_core'
+require '<%=file_name%>/engine'

data/lib/spree/templates/extension/lib/%file_name%/engine.rb.tt

@@ -0,0 +1,24 @@
+module <%= class_name %>
+  class Engine < Rails::Engine
+    engine_name '<%= file_name %>'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end