laravel 0.5.1 → 0.7.0

data/features/step_definitions/config_steps.rb

@@ -1,30 +1,41 @@
-Then /^configuration: "(.*?)" should be updated to "(.*?)"$/ do |config, value|
-  value = '.*' if value == "__something__"
-  @app_tester.validate_configuration("'#{config}' => '#{value}'")
-  step "the stdout should contain \"Updated configuration: #{config}\""
+# specific to most configuration updates #
+
+# specify the configuration settings we want to use when running the test
+Given /^I want to (?:set|use|configure) "(.*?)" as(?:| the)(?:| application) "(.*?)"$/ do |value, setting|
+  @config = "#{@config}#{setting}:#{value},"
+end
+Given /^I want to "(.*?)" (?:|the )"(.*?)"$/ do |switch, setting|
+  switch = ["enable"].include?(switch)
+  @config = "#{@config}#{setting}:#{switch ? "on" : "off"},"
 end
 
+# run a command in the application being tested
+When /^I run `(.*?)` inside this application$/ do |command|
+  step "I run `#{command} --app=#{@app.path}`"
+end
 
+# make sure that the configuration setting was updated correctly
+Then /^(?:|the )(?:|application )"(.*?)" should be updated to "(.*?)"$/ do |setting, value|
+  step "configuration: \"#{setting}\" should be updated to: \"#{value}\""
+end
+Then /^the "(.*?)" should be turned (on|off)$/ do |setting, value|
+  step "configuration: \"#{setting}\" should be updated to: \"#{value == "on"}\""
+end
 
+# specify if we want to generate a new application key
 Given /^I( do not)? want to generate a new key$/ do |negate|
-  @args = "#{@args} #{negate ? "--no-key" : "--key"}"
-end
-When /^(?:|I |we )generate a new key(?:| for this application)$/ do
-  step "I run `laravel config key --app=#{@app_path}`"
+  @config = "#{@config}#{negate ? "" : "key,"}"
 end
-Then /^a new application key should be generated$/ do
-  step "configuration: \"key\" should be updated to \"__something__\""
+# make sure that the application key was updated to something
+Then /application key should be generated$/ do
+  step "configuration: \"key\" should be updated to: \"__something__\""
 end
 
 
 
-Given /^I want to use "(.*?)" as application index$/ do |index|
-  @args = "#{@args} --index=#{index}"
-end
-When /^.*udpate application index to "(.*?)"$/ do |index|
-  step "I run `laravel config index #{index} --app=#{@app_path}`"
-end
-Then /^the application index should be updated to "(.*?)"$/ do |index|
-  step "configuration: \"index\" should be updated to \"#{index}\""
+# check configuration for a key => value pair
+Then /^configuration: "(.*?)" should be updated to: "(.*?)"$/ do |config, value|
+  validate_configuration(config, value, @app.config_file)
+  step "the stdout should contain \"Updated configuration: #{config}\""
 end
 

data/features/step_definitions/new_steps.rb

@@ -1,47 +1,78 @@
+# laravel framework exists in a given directory
 Given /^laravel (?:framework|application)( does not)? exists? in "(.*?)" directory$/ do |negate, dir|
-  dir = File.expand_path(dir, Laravel::AppTests::TestDirectory)
+  dir = expand_path(dir)
   FileUtils.rm_rf(dir)
   # easiest way to do this is to download github repository at this location
   `git clone -q http://github.com/laravel/laravel #{dir}` unless negate
 end
 
+# local cache exists for a given repository
 Given /^local cache for "(.*?)" (does not )?exists?$/ do |repo, negate|
-  tester = Laravel::AppTests.new(".", repo)
-  if negate
-    FileUtils.rm_rf tester.app.cache
-  elsif not tester.app.has_cache?
-    # easiest method to ensure local cache exists is to clone repo from github
-    FileUtils.rm_rf tester.app.cache
-    `git clone #{tester.app.source} #{tester.app.cache} &>/dev/null`
-  end
+  app = create_test_app nil, repo
+  FileUtils.rm_rf app.cache if negate or not app.has_cache?
+  # easiest method to ensure local cache exists is to clone repo from github
+  `git clone -q #{app.source} #{app.cache}` unless app.has_cache?
 end
 
+# no applications have been created => local cache does not exist
 Given /^(no )?applications? (?:has|have) been created using "(.*?)" as source$/ do |negate, repo|
-  step "local cache for \"#{repo}\" #{negate ? "does not exist" : "exists"}"
+  step "local cache for \"#{repo}\"#{negate ? " does not" : ""} exist"
 end
 
-
-
+# create an application
 When /^.*create (?:an|this) application(?:| with above requirements)( in the current directory)?$/ do |current_dir|
-  dir = current_dir ? "." : "my_app"
-  @source   ||= "http://github.com/laravel/laravel"
-  @app_tester = Laravel::AppTests.new(dir, @source)
-  @app        = @app_tester.app
-  @app_path   = @app_tester.app_path
-  @cache      = @app_tester.app.cache
-
-  step "I run `laravel new #{dir} #{@args}`"
+  @source ||= "http://github.com/laravel/laravel"
+  @app      = create_test_app current_dir, @source
+  @config   = @config.chomp(",")
+  @args     = "#{@args} --config=#{@config}" unless @config.empty?
+  step "I run `laravel new #{@app.path} #{@args}`"
 end
 
-
+# make sure that the application is ready for development
 Then /^(?:|this |the )application should be ready for development$/ do
   step "local cache should exist"
   step "application should be created"
+  step "I should not fail while doing so"
 end
+# check if the local cache exists after we create an application
 Then /^local cache should( not)? exist$/ do |negate|
-  @app_tester.raise_error?(@app.has_cache?, negate)
+  message = "local cache at #{@app.cache} to exist for source => #{@app.source}"
+  unexpected?(@app.has_cache?, !negate, message)
 end
+# check if the application was created successfully
 Then /^application should( not)? be created$/ do |negate|
   step "the stdout should contain \"Hurray!\"" unless negate
-  @app_tester.raise_error?(@app.has_laravel?, negate)
+  message = "application to be created"
+  unexpected?(@app.has_laravel?, !negate, message)
+end
+
+# start creating an application and initialize @args, @config parameters
+Given /.*want to create (?:an|the|a new) application( forcefully)?$/ do |force|
+  @config = ""
+  @args = force ? "--force" : ""
+end
+
+# specify a source repository
+Given /^I want to use( local cache for)? "(.*?)" as source$/ do |use_cache, source|
+  @source = source
+  @args = "#{@args} --source=#{source}"
+end
+
+# specify whether we want to udpate permissions or not
+Given /^I( do not)? want to update file permissions for storage$/ do |negate|
+  @args = "#{@args} #{negate ? "--no-perms" : "--perms"}"
+end
+# check if the permissions were updated
+Then /^file permissions on storage should( not)? be updated$/ do |negate|
+  step "the stdout should contain \"Updated permissions\"" unless negate
+
+  storage_dir = File.join(@app.path, "storage")
+  # capture the last integer for the permissions mode
+  world_bit = sprintf("%o", File.stat(storage_dir).mode).to_s[-1,1].to_i
+  # file is world-writable if last integer is 2, 3, 6, or 7
+  actual = [2,3,6,7].include?(world_bit)
+
+  expected = !negate
+  message = "#{storage_dir} to be world-writable"
+  unexpected?(actual, expected, message)
 end

data/features/support/env.rb

@@ -3,7 +3,7 @@ require "laravel"
 
 # After a scenario has been ran, deleted the files we may have created.
 After do
-  test_directory = File.expand_path(File.join(File.dirname(__FILE__), %w[ .. .. tmp aruba]))
+  test_directory = Laravel::TestHelpers::TestDirectory
   FileUtils.rm_rf(File.join(test_directory, "my_app"))
   FileUtils.rm_rf(File.join(test_directory, "laravel"))
   FileUtils.rm_rf(File.join(test_directory, "current"))
@@ -12,3 +12,5 @@ end
 Before do
   @aruba_timeout_seconds = 300
 end
+
+World(Laravel::Helpers)

data/features/support/spec_helpers.rb

@@ -0,0 +1,74 @@
+module Laravel
+  # various methods that help with the Cucumber Tests
+  module TestHelpers
+    TestDirectory = File.expand_path(File.join(File.dirname(__FILE__), %w[ .. .. tmp aruba]))
+
+    # expand path to a directory relative to the test directory
+    #
+    # ==== Parameters
+    # +dir+ :: path to the application directory
+    #
+    # ==== Return
+    # +string+ :: absolute path to the application directory
+    #
+    def expand_path(dir = nil)
+      dir ||= Dir.pwd
+      File.expand_path(dir, TestDirectory)
+    end
+
+    # checks if the configuration file contains a particular string
+    #
+    # ==== Parameters
+    # +search+ :: the search term/regex pattern to look for
+    #
+    # ==== Return
+    # +boolean+:: true, if the search term was found in the configuration file.
+    #
+    def validate_configuration(config, value, config_file)
+      match = File.read(config_file).match(/'#{config}' => (.*),/)
+      expected = !match.nil?
+      message = "configuration \"#{config}\" to be present in the configuration file."
+      unexpected_unless expected, message
+
+      # quote the value if it is not boolean
+      value = "'#{value}'" unless ["true", "false"].include?(value)
+      # config is valid if it matches the passed value or if its "__something__"
+      expected = (value == "'__something__'") || (value == match[1])
+      message = "configuration \"#{config}\" to be \"#{value}\" instead of \"#{match[1]}\""
+      unexpected_unless expected, message
+    end
+
+    def create_test_app(dir = nil, repo = nil)
+      dir     = dir ? "." : "my_app"
+      dir     = expand_path(dir)
+      options = { :force => true, :quiet => false, :perms => true, :source => repo }
+      Laravel::App.new(dir, options)
+    end
+
+    # raises an error based on a condition and negation
+    # if negation is not supplied, simply raises an error if condition is not true
+    #
+    # ==== Parameters
+    # +actual+   :: a condition to check against - if +expected+ is not provided,
+    #               raises an error if +actual+ is (or evaluates to) false
+    # +expected+ :: negate the default behaviour
+    def unexpected?(actual, expected, message = "")
+      message ||= "#{expected} instead of #{actual}"
+      message   = "#{expected ? "Expected" : "Did not expect"} #{message}"
+      # actual and expected can either be boolean or string
+      actual    = !actual.empty? if actual.is_a?(String) and not expected.is_a?(String)
+      raise ExpectationNotMetError, message if actual != expected
+    end
+
+    def unexpected_if(actual, message = "")
+      unexpected? actual, false, message
+    end
+
+    def unexpected_unless(actual, message = "")
+      unexpected? actual, true, message
+    end
+
+  end
+end
+
+World(Laravel::TestHelpers)

data/laravel.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Laravel::VERSION
   gem.authors       = ["Nikhil Gupta"]
   gem.email         = ["me@nikhgupta.com"]
-  gem.description   = %q{A wrapper around Laravel framework for PHP}
-  gem.summary       = %q{This gem is a wrapper around the Laravel framework for PHP. Initially, the gem would allow to create new laravel apps along with options to modify the default behavior for these new installations.}
+  gem.description   = %q{Readily build new web applications using Laravel framework for PHP.}
+  gem.summary       = %q{This gem helps in readily creating new web application based on the Laravel framework for PHP with as much customization as possible. Moreover, it allows configuring existing Laravel applications, and installing Laravel bundles for them.}
   gem.homepage      = "https://github.com/nikhgupta/laravel"
 
   gem.files         = `git ls-files`.split($/)
@@ -17,12 +17,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  # add some dependecies for this gem
   gem.add_dependency 'thor'
 
+  # add some dependencies for this gem when in the development environment
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'aruba'
-  # gem.add_development_dependency 'rspec'
-  # gem.add_development_dependency 'guard-rspec'
-  # gem.add_development_dependency 'rb-fsevent'
-  # gem.add_development_dependency 'growl'
 end

data/lib/laravel.rb

@@ -1,6 +1,5 @@
 # require dependencies
 require "thor"
-require "yaml"
 
 # require laravel files
 require "laravel/version"
@@ -9,4 +8,3 @@ require "laravel/helpers"
 require "laravel/app_support"
 require "laravel/app"
 require "laravel/configuration"
-require "laravel/installer"

data/lib/laravel/app.rb

@@ -4,35 +4,67 @@ module Laravel
   # AppSupport module, which is being included as a mixin here.
   #
   class App
-    # include the AppSupport module which has all the methods defined.
+    # include the Helpers and AppSupport modules which have all the helper methods defined.
     include Laravel::Helpers
     include Laravel::AppSupport
 
     # these attributes must be available as: object.attribute
-    attr_reader   :cache_folder, :laravel_repo, :app_path, :source, :cache, :options
+    attr_reader   :path, :source, :cache, :options
 
     # This method initializes a new App object for us, on which we can apply
     # our changes.  Logically, this new App object represents an application
     # based on Laravel.
     #
     # ==== Parameters
-    # +app_path+ :: The path to the Laravel based application. This can either
+    # +path+ :: The path to the Laravel based application. This can either
     # be a relative path to the current directory, or the absolute path. If
-    # +app_path+ is not supplied, we assume current directory.
+    # +path+ is not supplied, we assume current directory.
     #
     # +options+  :: A hash of options for this application. This hash can be
     # created manually, but more closely resembles the options choosen by the
     # user and forwarded by the Thor to us.
     #
-    def initialize(app_path = nil, options = nil)
-      app_path = Dir.pwd if not app_path or app_path.empty?
-      @app_path = File.expand_path(app_path)
+    def initialize(path = nil, options = nil)
+      self.path    = path
+      self.options = options
+      self.source  = options[:source] if options
+      self.source  = LaravelRepo if not @source
+    end
+
+    # Expands the supplied +path+ for the application so that we have an absolute
+    # directory path to work with.
+    #
+    # ==== Parameters
+    # +path+ :: The path to the laravel based application. If path is not supplied,
+    # we assume the current directory.
+    #
+    def path=(path="")
+      path = Dir.pwd if not path or path.empty?
+      @path = File.expand_path(path)
+    end
 
-      @options = options
+    # Merge the given options with the already existing options.
+    #
+    # ==== Parameters
+    # +options+ :: a hash of options to merge
+    #
+    def options=(options={})
+      @options = @options ? @options.merge(options) : options
+    end
 
+    # Set the source for this application, and implicitely, set the directory
+    # path for the local cache for this source.
+    #
+    # ==== Parameters
+    # +source+ :: the source url or directory path
+    #
+    def source=(source=nil)
+      # source must default to Official Laravel Repository if none is provided
       @source = options[:source] if options
       @source = LaravelRepo if not @source or @source.empty?
 
+      # if the specified source is a remote repository, create a cache
+      # directory otherwise, use the source as the cache
       @cache = source_is_local? ? @source : cache_directory
     end
 
@@ -42,8 +74,7 @@ module Laravel
     # cache for the given source, and then copies over the files from this
     # cache to the specified directory. Finally, it checks if we have a working
     # Laravel application at which point it either raises and error and cleans
-    # up, or configures the application and installs tasks/bundles, as
-    # requested.
+    # up, or configures the application, as requested.
     #
     def create
       # check if we are missing the required force
@@ -58,33 +89,36 @@ module Laravel
       # copy the framework files from the cache
       copy_over_cache_files
 
-      # make necessary changes for the new app, if we were successful in download
-      # otherwise, remove the downloaded source
+      # make necessary changes for the new app, if we were successful in
+      # download otherwise, remove the downloaded source
       if has_laravel?
         say_success "Cloned Laravel repository."
+
+        # update permissions on storage/ directory (this is the default)
+        update_permissions_on_storage if @options[:perms]
+
+        # configure this new application, as required
         configure_from_options
-        install_from_options
+
         say_success "Hurray! Your Laravel application has been created!"
       else
-        say_failed "Downloaded source is not Laravel framework or a possible fork."
+        say_failed "Downloaded source is not Laravel framework or its fork."
         show_info "Cleaning up.."
+        # remove all directories that we created, as well as the cache.
         clean_up
-        raise InvalidSourceRepositoryError
+        # raise an error since we failed.. :(
+        raise LaravelError, "Source for downloading repository is corrupt!"
       end
     end
 
-    # This method installs the required tasks/bundles by the user.
-    # It does so by invoking the 'from_options' method of the Installer class.
-    def install_from_options
-      install = Installer.new(@app_path, @options)
-      install.from_options
-    end
-
     # This method configures the application as required by the user.
     # It does so by invoking the 'from_options' method of the Configuration class.
+    #
     def configure_from_options
-      config = Configuration.new(@app_path, @options)
-      config.update_from_options
+      if @options[:config]
+        config = Configuration.new(@path, @options[:config])
+        config.from_options
+      end
     end
   end
 end

data/lib/laravel/app_support.rb

@@ -3,15 +3,31 @@ require 'digest/md5'
 module Laravel
   # various methods that help with various classes defined for the Laravel module
   module AppSupport
+    # include various Laravel Helpers
     include Laravel::Helpers
 
+    # Run a command using 'artisan'
+    #
+    # ==== Parameters
+    # +command+ :: command to run
+    #
+    def artisan(command, options = {})
+      raise LaravelNotFoundError unless laravel_exists_in_directory?(@path)
+      php = `which php`.strip
+      raise RequiredLibraryMissingError, "php" unless php
+      command = "#{php} #{@path}/artisan #{command}"
+      output = `#{command}`
+      puts output unless options[:quiet]
+      ($?.exitstatus == 0)
+    end
+
     # Return the path to the local cache directory for a given Source
     #
     # ==== Return
     # +string+ :: Filepath to the local cache directory
     #
     def cache_directory
-      File.join(Laravel::App::CacheFolder, make_md5(@source))
+      File.join(CacheFolder, make_md5(@source))
     end
 
     # Check whether the app directory is the current directory.
@@ -22,7 +38,7 @@ module Laravel
     # +boolean+ :: True, if the app directory is the current directory.
     #
     def create_in_current_directory?
-      is_current_directory?(@app_path)
+      is_current_directory?(@path)
     end
 
     # Check whether the app directory is empty?
@@ -34,7 +50,7 @@ module Laravel
     # +boolean+ :: True, if the app directory is an empty one.
     #
     def create_in_empty_directory?
-      is_empty_directory?(@app_path)
+      is_empty_directory?(@path)
     end
 
     # Check whether the specified source is a local directory or a URL?
@@ -46,25 +62,13 @@ module Laravel
       File.directory?(@source)
     end
 
-    # Merge the specified options with the options specified on the command line.
-    #
-    # ==== Parameters
-    # +options+ :: hash of options passed at the command line
-    #
-    # ==== Return
-    # +hash+ :: hash of merged options
-    #
-    def merge_options(options)
-      @options.merge!(options)
-    end
-
     # Return the path to the configuration file for the current application
     #
     # ==== Return
     # +string+ :: path to the configuration file
     #
     def config_file
-      File.join(@app_path, %w[ application config application.php ])
+      File.join(@path, %w[ application config application.php ])
     end
 
     # Return the path to a tasks file by its name
@@ -76,7 +80,7 @@ module Laravel
     # +string+ :: path to the tasks file
     #
     def tasks_file(name)
-      File.expand_path(File.join(@app_path, %w[ application tasks ], name))
+      File.expand_path(File.join(@path, %w[ application tasks ], name))
     end
 
     # check if laravel framework exists in the current application's directory
@@ -87,7 +91,7 @@ module Laravel
     # +boolean+ :: true, if laravel framework exists
     #
     def has_laravel?
-      laravel_exists_in_directory?(@app_path)
+      laravel_exists_in_directory?(@path)
     end
 
     # check if the cache exists for the source specified by the current
@@ -105,20 +109,21 @@ module Laravel
     # the 'force' option, and then checks if the 'force' option is provided
     # by the user.
     #
-    # Whether the path requires 'force' is determined as:
-    #   -- it is not the current directory
-    #   -- it is the current directory but is empty
+    # 'force' is required if the application path:
+    #   -- exists but is not the current directory
+    #   -- is the current directory but is not empty
     #
-    # ==== Return
-    # +error+ :: raises an error, if the 'force' parameter is required!!
+    # ==== Raises
+    # +LaravelError+ :: if the 'force' parameter is required!!
     #
     def required_force_is_missing?
       # we need force if path exists and is not the current directory
-      check_force   = (File.exists?(@app_path) and not create_in_current_directory?)
+      check_force   = (File.exists?(@path) and not create_in_current_directory?)
       # we need force if path is current directory but is not empty
       check_force ||= (create_in_current_directory? and not create_in_empty_directory?)
       # raise an error when we need to force and we have not been supplied with enforcements
-      raise RequiredForceMissingError if check_force and not @options[:force]
+      message = "Overwrite required. You must pass in 'force' flag to overwrite!"
+      raise LaravelError, message if check_force and not @options[:force]
     end
 
     # Depending on whether the 'force' parameter is provided, this method
@@ -128,8 +133,8 @@ module Laravel
     #
     def apply_force
       show_info "Creating application forcefully!" if @options[:force]
-      FileUtils.rm_rf("#{@app_path}/.", :secure => true) if File.exists?(@app_path) and @options[:force]
-      FileUtils.mkdir_p @app_path
+      FileUtils.rm_rf("#{@path}/.", :secure => true) if File.exists?(@path) and @options[:force]
+      FileUtils.mkdir_p @path
     end
 
     # This method downloads or updates the local cache for the current source.
@@ -142,17 +147,21 @@ module Laravel
     # caches it locally.
     #
     def download_or_update_local_cache
+      # we have nothing to download if the source is a local directory
       return if source_is_local?
+      # we need git for this purpose
       raise RequiredLibraryMissingError, "git" if `which git`.empty?
+
+      # create the cache, and download or update as required
       FileUtils.mkdir_p @cache
       Dir.chdir(@cache) do
         if has_cache?
           show_info "Repository exists in local cache.."
           show_info "Updating local cache.."
-          `git pull &>/dev/null`
+          `git pull -q`
         else
           show_info "Downloading repository to local cache.."
-          `git clone #{@source} . &>/dev/null`
+          `git clone -q #{@source} .`
         end
       end
     end
@@ -161,17 +170,17 @@ module Laravel
     # application.
     #
     def copy_over_cache_files
-      FileUtils.cp_r "#{@cache}/.", @app_path
+      FileUtils.cp_r "#{@cache}/.", @path
     end
 
-    # This method updates the permissions on the storage/ directory inside
-    # the newly created application. This method does not have a separate exposed
-    # call from the CLI. This can be skipped by passing '--no-perms' for the 'new'
-    # command.
+    # This method updates the permissions on the storage/ directory inside the
+    # newly created application. This method does not have a separate exposed
+    # call from the CLI. This can be skipped by passing '--no-perms' flag for
+    # the 'new' command.
     #
     def update_permissions_on_storage
       if @options[:perms]
-        response = system("chmod -R o+w #{File.join(@app_path, 'storage')}")
+        response = system("chmod -R o+w #{File.join(@path, 'storage')}")
         if response
           say_success "Updated permissions on storage/ directory."
         else
@@ -186,18 +195,11 @@ module Laravel
     #
     # Keeping the local cache does not make sense, since we anyways can not create
     # applications based on these 'corrupt' repositories.
+    #
     def clean_up
-      FileUtils.rm_rf "#{@app_path}" unless create_in_current_directory?
+      FileUtils.rm_rf "#{@path}" unless create_in_current_directory?
       FileUtils.rm_rf "#{@cache}"
     end
 
-
-    def read_gem_settings
-      read_yaml GemSettings
-    end
-
-    def write_gem_settings(data)
-      write_yaml data, GemSettings
-    end
   end
 end