laravel 0.2.1 → 0.3.2

data/README.md

@@ -1,4 +1,4 @@
-# Laravel
+[[#]] Laravel
 
 A wrapper around Laravel framework for PHP.
 Currently, is only capable of downloading Laravel source from
@@ -76,12 +76,15 @@ cached!
 ### In an existing Laravel application
 
     # update Application Index for the application
-    laravel update_index ''  # removes application index for app in current directory
-    laravel update_index 'home.php' --app=./new_app # update for app in specified directory
+    laravel config index ''  # removes application index for app in current directory
+    laravel config index 'home.php' --app=./new_app # update for app in specified directory
 
     # generate a new key for the application
-    laravel generate_key # generates key for app in current directory
-    laravel generate_key --app=./new_app # generate key for app in specified directory
+    laravel config key # generates key for app in current directory
+    laravel config key --app=./new_app # generate key for app in specified directory
+    
+    # download the Laravel generator by Jeffrey Way
+    laravel install generator --app=./new_app
 
 ### Help
 
@@ -90,9 +93,9 @@ cached!
 ## Coming Soon..
     # create and customize a new Laravel application
     <del>laravel new my_app --index=''           # set application index to blank</del>
-    <del>laravel new my_app --key                # generate a new key<del>
+    <del>laravel new my_app --key                # generate a new key</del>
+    <del>laravel new my_app --[no-]generator     # download the Laravel Generator by Jeffrey Way</del>
     laravel new my_app --database=db_my_app # create a database, defaults to app name
-    laravel new my_app --[no-]generator     # download the Laravel Generator by Jeffrey Way
     laravel new my_app --bundles=sentry,bob # install the provided bundles
 
 ## Contributing

data/bin/commands/config.rb

@@ -0,0 +1,33 @@
+module Laravel
+  # This module handles the subcommands used by this gem.
+  module Commands
+    # Handle config subcommands.
+    # This class inherits from thor and can be used to configure
+    # various options in the application/config/application.php file.
+    class Config < Thor
+
+      # This class-wide option specifies the application directory to use.
+      # By default, this is the path to the current directory.
+      class_option :app, :type => :string, :aliases => "-a",
+        :desc => "use the specified Laravel application instead of current directory"
+
+      # This task updates the Application Index for an application.
+      #
+      desc "index [NEW_INDEX]", "modify the Application Index for Laravel application"
+      def index(new_index)
+        @config = Laravel::Configuration.new(options[:app])
+        @config.update_index new_index
+      end
+
+      # This task generates a new key for our application.
+      #
+      desc "key", "generate a new key for Laravel application"
+      def key(value=nil)
+        @config = Laravel::Configuration.new(options[:app])
+        @config.update_key
+      end
+
+    end
+  end
+end
+

data/bin/commands/install.rb

@@ -0,0 +1,32 @@
+module Laravel
+  # This module handles the subcommands used by this gem.
+  module Commands
+    # This class is responsible for the various installation tasks
+    # e.g. installing the bundles or other goodies.
+    class Install < Thor
+
+      # This option specifies the application directory to use.
+      # By default, this is the path to the current directory.
+      class_option :app, :type => :string, :aliases => "-a",
+        :desc => "use the specified Laravel application instead of current directory"
+
+      # This option specifies whether we want to forcefully install
+      # the resource by overwriting already existing files.
+      # Virtually, this is the same as reinstalling a certain resource.
+      class_option :force, :type => :boolean,
+        :desc => "force an installation - same as reinstall"
+
+      # This task downloads the Laravel Generator by Jeffrey Way and creates
+      # a file called 'generate.php' in the tasks folder.
+      #
+      # Once done, we can use `php artisan generate` to get an overview of the
+      # different actions this laravel-task can perform.
+      #
+      desc "generator", "download the Laravel Generator by Jeffrey Way"
+      def generator
+        @installer = Laravel::Installer.new(options[:app])
+        @installer.task_generator
+      end
+    end
+  end
+end

data/bin/commands/new.rb

@@ -0,0 +1,45 @@
+module Laravel
+  class CLI < Thor
+    # This task creates a new application based on Laravel framework.  By
+    # default, it simply copies a Laravel source to the path specified as the
+    # argument. However, this method is heavily customizable and allows us to
+    # create a ready to use Laravel application by handling tasks such as
+    # updating the Application Index, generating a new key, updating
+    # permissions on the storage/ directory, and even creating migration tables
+    # for us in one go.
+    #
+    # ==== Options
+    # +source+ :: [STRING] Specifies the source repository for downloading Laravel. This can
+    #               either be an absolute/relative path from the current directory,
+    #               or a URL to a git based repository we have access to. This can be
+    #               very handy since it allows us to create new application based on a
+    #               fork of the Laravel framework that we may have been working on.
+    #               Furthermore, since we cache these source URLs, it speeds up future
+    #               app creations using this method.
+    # +perms+    :: [BOOLEAN] By default, it updates the permissions on the storage/ directory
+    #               The permissions update can be skipped, by passing a '--no-perms' parameter.
+    # +force+    :: [BOOLEAN] If we can not create an application at the specified path since it
+    #               already exists or is not empty, passing this parameter will force us to create
+    #               a new application, by first removing all the files inside the specified path.
+    # +index+    :: [STRING] If provided, updates the Application Index to this string.
+    # +key+      :: [BOOLEAN] If provided, generates a new key for our application.
+    # +generator+:: [BOOLEAN] If provided, this downloads the Laravel Generator by Jeffrey Way.
+    #
+    desc "new [MY_APP]", "create a new Laravel application"
+    method_option :force,  :type => :boolean, :desc => "force overwrite"
+    method_option :source, :type => :string,  :aliases => "-s", :banner => "GIT_REPO",
+      :desc => "use this git repository - can be a directory or a URL"
+    method_option :perms, :type => :boolean, :default => true,
+      :desc => "default | update permissions on storage/ directory"
+    method_option :index,  :type => :string,  :aliases => "-i",
+      :desc => "change the Application Index"
+    method_option :key,    :type => :boolean, :aliases => "-k",
+      :desc => "generate a new key for this application"
+    method_option :generator, :type => :boolean, :aliases => "-g",
+      :desc => "get the Laravel generator by Jeffrey Way"
+    def new(app_name)
+      Laravel::App.new(app_name, options).create
+    end
+
+  end
+end

data/bin/laravel

@@ -5,80 +5,55 @@
 require "pathname"
 bin_file = Pathname.new(__FILE__).realpath
 
-# add self to libpath
+# add 'lib' and 'bin' folders to the load path.
 $:.unshift File.expand_path(File.join(%w[ .. .. lib]), bin_file)
+$:.unshift File.expand_path(File.join(%w[ .. .. bin]), bin_file)
 
 require "laravel" # which indirectly requires 'thor'
 
+# require our commands
+require "commands/new"
+require "commands/config"
+require "commands/install"
+
 module Laravel
+  # A means to create and manage applications based on the Laravel
+  # framework for PHP. This has a neat command-subcommand structure
+  # which imitates Git. This is run when we invoke Laravel over CLI.
   class CLI < Thor
 
-    # display version/information about this gem
-    # default   => display usage information for the gem
-    # --version => display current Laravel version
-    desc "info", "displays usage information about this gem."
-    method_options %w( version -v) => :boolean
-    def info
-      puts options[:version] ? "Laravel v#{Laravel::VERSION}" : Laravel::INFO
+    # choose a default task to run
+    default_task :version
+
+    # map some inputs to tasks
+    map "-T" => "help", "-C" => "config", "-I" => "install", "-N" => "new"
+
+    # config subcommand that manipulates app configuration
+    #
+    # +command+ :: subcommand to run.
+    #
+    desc "config [COMMAND]", "configure an existing application"
+    subcommand "config", Laravel::Commands::Config
+
+    # install subcommand that gets us some bundles and goodies
+    #
+    # +command+ :: subcommand to run.
+    #
+    desc "install [COMMAND]", "install bundles and other goodies"
+    subcommand "install", Laravel::Commands::Install
+
+    # display version information for this gem but is a hidden task,
+    # which means that it will not be shown in the 'help' overview.
+    #
+    # +version+ :: display current Laravel version, aliased as '-v'
+    #
+    desc "version", "displays usage information about this gem.", :hide => true
+    method_option :version, :type => :boolean, :aliases => "-v"
+    def version
+      puts "Laravel v#{Laravel::VERSION}"
       # puts "Made possible by efforts of Laravel Community"
     end
 
-    # create a new laravel application
-    # default  => create a bare bone Laravel application
-    # --local  => use a local directory for source
-    # --remote => use a remote git repository for source
-    # --force  => overwrite target directory, if it exists
-    # --index  => update Application Index for newly created application
-    # --key    => generate a new key for this application
-    # --[no-]perms => do not update permissions on storage/ directory
-    desc "new [MY_APP]", "create a new Laravel application"
-    method_option :local,  :type => :string,  :aliases => "-l", :banner => "DIRECTORY",
-      :desc => "use laravel source from a local directory"
-    method_option :remote, :type => :string,  :aliases => "-r", :banner => "GIT_REPO",
-      :desc => "use this git repository instead (useful when working with forks, e.g.)"
-    method_option :force,  :type => :boolean, :desc => "force overwrite"
-    method_option :index,  :type => :string,  :aliases => "-i",
-      :desc => "change the Application Index"
-    method_option :key,    :type => :boolean, :aliases => "-k",
-      :desc => "generate a new key for this application"
-    method_option :perms, :type => :boolean, :default => true,
-      :desc => "default | update permissions on storage/ directory"
-    method_option :generator, :type => :boolean, :aliases => "-g",
-      :desc => "get the Laravel generator by Jeffrey Way"
-    def new(app_name)
-      Laravel::Create::source app_name, options
-    end
-
-    # allow the user to modify Application Index
-    # --app => use the given directory instead of pwd
-    desc "update_index [NEW_INDEX]", "modify the Application Index for Laravel application"
-    method_option :app, :type => :string, :aliases => "-a",
-      :desc => "use the specified Laravel application instead of current directory"
-    def update_index(new_index)
-      Laravel::Manage::update_index new_index, options[:app]
-    end
-
-    # allow the user to generate a new key
-    # --app => use the given directory instead of pwd
-    desc "generate_key", "generate a new key for Laravel application"
-    method_option :app, :type => :string, :aliases => "-a",
-      :desc => "use the specified Laravel application instead of current directory"
-    def generate_key
-      Laravel::Manage::generate_key options[:app]
-    end
-
-    # allow the user to download the generator from Jeffrey Way
-    # --app => use the given directory instead of pwd
-    desc "get_generator", "download the Laravel Generator by Jeffrey Way"
-    method_option :app, :type => :string, :aliases => "-a",
-      :desc => "use the specified Laravel application instead of current directory"
-    def get_generator
-      Laravel::Manage::get_generator options[:app]
-    end
-
-    # choose a default task to run
-    default_task :info
-
   end
 end
 

data/features/S_1_new.feature

@@ -3,28 +3,28 @@ Feature: Create a new application based on Laravel framework for PHP
   As a PHP developer acquinted with ruby
   I want to use Laravel gem to setup Laravel framework
 
-  @requires_repository_download @very_slow @online
+  @requires_repository_download @very_slow @online 
   Scenario: create Laravel application with default settings
     Given local cache does not exist for "official" repository
     When  I run `laravel new my_app`
     Then  laravel application should be ready to use in "my_app" directory
 
-  @may_require_repository_download
+  @may_require_repository_download 
   Scenario: create Laravel application in the current directory
     When  I run `laravel new . --force`
     Then  laravel application should be ready to use in "." directory
     When  I run `laravel new .`
     Then  the stdout should contain "ERROR"
 
-  @requires_repository_download @online
+  @requires_repository_download @online 
   Scenario: create Laravel application using source from a non-official repo
     Given local cache does not exist for "pastes" repository
-    When  I run `laravel new my_app --remote=http://github.com/laravel/pastes`
+    When  I run `laravel new my_app --source=http://github.com/laravel/pastes`
     Then  laravel application should be ready to use in "my_app" directory using "pastes" repository
 
   @requires_repository_download @online
   Scenario: create Laravel application using non-laravel repository
-    When  I run `laravel new my_app --remote=http://github.com/github/gitignore`
+    When  I run `laravel new my_app --source=http://github.com/github/gitignore`
     Then  local cache for "non_laravel" repository should not exist
     And   the stdout should contain "source is corrupt"
     And   the stdout should contain "ERROR"
@@ -33,13 +33,13 @@ Feature: Create a new application based on Laravel framework for PHP
   @may_require_repository_download
   Scenario: create Laravel application using repository from local cache
     Given local cache exists for "pastes" repository
-    When  I run `laravel new my_app --remote=http://github.com/laravel/pastes`
+    When  I run `laravel new my_app --source=http://github.com/laravel/pastes`
     Then  laravel application should be ready to use in "my_app" directory using "pastes" repository
 
-  @may_require_repository_download
+  @may_require_repository_download 
   Scenario: create Laravel application using source from a directory
     Given laravel source has already been downloaded in "laravel" directory
-    When  I run `laravel new my_app --local=laravel`
+    When  I run `laravel new my_app --source=laravel`
     Then  laravel application should be ready to use in "my_app" directory
 
   @may_require_repository_download
@@ -51,9 +51,9 @@ Feature: Create a new application based on Laravel framework for PHP
 
   @may_require_repository_download
   Scenario: create Laravel application with maximum customizations
-    When I run `laravel new -kgi 'home.php' -r http://github.com/laravel/pastes my_app --force`
-    Then laravel application should be ready to use in "my_app" directory
+    When I run `laravel new -kgi 'home.php' -s http://github.com/laravel/pastes my_app --force`
+    Then laravel application should be ready to use in "my_app" directory using "pastes" repository
     And  the stdout should contain "Creating application forcefully"
-    And  application key must be set for "my_app" application
-    And  application index must be set to "home.php" for "my_app" application
-    And  generator tasks should be setup for "my_app" application
+    And  configuration: "key" must be updated to "__something__" for "my_app" application
+    And  configuration: "index" must be updated to "home.php" for "my_app" application
+    And  task: "generator" should be installed as "generate.php" for "my_app" application

data/features/S_2_generate_key.feature

@@ -6,12 +6,11 @@ Feature: Generate a new key for Laravel application
   @may_require_repository_download
   Scenario: generate a new key for a Laravel application
     Given laravel application exists in "my_app" directory
-    Then  application key must not be set for "my_app" application
-    When  I run `laravel generate_key --app=my_app`
-    Then  application key must be set for "my_app" application
+    When  I run `laravel config key --app=my_app`
+    Then  configuration: "key" must be updated to "__something__" for "my_app" application
 
   @may_require_repository_download
   Scenario: create Laravel application and generate a key for it
     When  I run `laravel new my_app --key`
     Then  laravel application should be ready to use in "my_app" directory
-    And   application key must be set for "my_app" application
+    And   configuration: "key" must be updated to "__something__" for "my_app" application

data/features/S_3_update_index.feature

@@ -6,11 +6,11 @@ Feature: Update Application Index for a Laravel based application
   @may_require_repository_download
   Scenario: update Application Index in a Laravel application
     Given laravel application exists in "my_app" directory
-    When  I run `laravel update_index 'home.php' --app=my_app`
-    Then  application index must be set to "home.php" for "my_app" application
+    When  I run `laravel config index 'home.php' --app=my_app`
+    Then  configuration: "index" must be updated to "home.php" for "my_app" application
 
   @may_require_repository_download
   Scenario: create Laravel application without an Application Index
     When  I run `laravel new my_app --index=''`
     Then  laravel application should be ready to use in "my_app" directory
-    And   application index must be set to "" for "my_app" application
+    And   configuration: "index" must be updated to "" for "my_app" application

data/features/S_4_generator.feature

@@ -3,14 +3,14 @@ Feature: Download Laravel Generator by Jeffrey Way
   As a PHP developer acquinted with ruby
   I want to use Laravel gem to download Laravel Generator by Jeffrey Way
 
-  @may_require_repository_download
+  @may_require_repository_download 
   Scenario: download Laravel generator
     Given laravel application exists in "my_app" directory
-    When  I run `laravel get_generator --app=my_app`
-    Then  generator tasks should be setup for "my_app" application
+    When  I run `laravel install generator --app=my_app`
+    Then  task: "generator" should be installed as "generate.php" for "my_app" application
 
-  @may_require_repository_download
+  @may_require_repository_download 
   Scenario: download Laravel generator while creating an application
     When  I run `laravel new my_app --generator`
     Then  laravel application should be ready to use in "my_app" directory
-    And   generator tasks should be setup for "my_app" application
+    And  task: "generator" should be installed as "generate.php" for "my_app" application

data/features/step_definitions/laravel.rb

@@ -5,35 +5,50 @@ module Laravel
 end
 
 #### GIVEN ####
-# local cache exists
+
+# This test setups a given condition where the local cache may or may not exist
+# for a given source repository. It does so by removing the cache directory, and
+# then recreating it, if not negated, by downloading the repository from github.
+#
 Given /^local cache( does not)? exists? for "(.*?)" repository$/ do |negation, repo|
-  repo_url  = get_test_repo_url(repo)
-  repo_path = get_test_repo_path(repo, repo_url)
+  @app_tester = Laravel::AppTests.new(nil, repo)
+
   if negation
-    FileUtils.rm_rf repo_path
-  else
+    FileUtils.rm_rf @app_tester.app.cache
+  elsif not @app_tester.app.has_cache?
     # easiest method to ensure local cache exists is to clone repo from github
-    unless Laravel::has_laravel?(repo_path)
-      FileUtils.rm_rf repo_path
-      `git clone #{repo_url} #{repo_path} &>/dev/null`
-    end
+    FileUtils.rm_rf @app_tester.app.cache
+    `git clone #{@app_tester.app.source} #{@app_tester.app.cache} &>/dev/null`
   end
 end
 
-# laravel exists in directory
+# This test setups a given condition where the Laravel application exists in a
+# given directory. It does so by removing the directory if it exists and then,
+# creating a new Laravel application there.
+#
 Given /^laravel application exists in "(.*?)" directory$/ do |dir|
-  dir = get_relative_path_to_test_directory(dir)
-  Laravel::Create::source(dir, :force => true, :quiet => true) unless Laravel::has_laravel?(dir)
+  FileUtils.rm_rf(dir) if File.directory?(dir)
+  @app_tester = Laravel::AppTests.new(dir)
+  @app_tester.app.merge_options(:force => true, :quiet => true)
+  @app_tester.app.create unless @app_tester.app.has_laravel?
 end
 
-# laravel has been downloaded in directory
+# This test setups a given condition where the Laravel framework source has
+# been download in a given directory, which is essentially the same as testing
+# whether a Laravel application existing in a given directory.
+#
 Given /^laravel source has already been downloaded in "(.*?)" directory$/ do |dir|
   # creating laravel in directory is virtually same as it being downloaded there
   step "laravel application exists in \"#{dir}\" directory"
 end
 
 #### THEN ####
-# check if we have a running Laravel instance using 'Official' repository
+
+# This test checks whether the Laravel application we created is ready to use in
+# a given directory, which is to say whether we can readily use Laravel after
+# the command 'new' has been issued. This test assumes that the source repository
+# is the official Laravel repository.
+#
 Then /^laravel application should be ready to use in "(.*?)" directory$/ do |dir|
   step "local cache for \"official\" repository should exist"
   step "the stdout should contain \"Hurray!\""
@@ -41,7 +56,10 @@ Then /^laravel application should be ready to use in "(.*?)" directory$/ do |dir
   step "permissions should be updated on \"#{dir}/storage\" directory"
 end
 
-# check if we have a running Laravel instance using 'non-official' repository
+# This test checks whether the Laravel application we created is ready to use
+# in a given directory using a given source repository, which is to say whether
+# we can readily use Laravel after the command 'new' has been issued.
+#
 Then /^laravel application should be ready to use in "(.*?)" directory using "(.*?)" repository$/ do |dir, repo|
   step "local cache for \"#{repo}\" repository should exist"
   step "the stdout should contain \"Hurray!\""
@@ -49,50 +67,50 @@ Then /^laravel application should be ready to use in "(.*?)" directory using "(.
   step "permissions should be updated on \"#{dir}/storage\" directory"
 end
 
-# check if local cache exists
+# This test checks whether the local cache exists for a given repository. It
+# does so by calling the 'has_cache?' method on the application.
+#
 Then /^local cache for "(.*?)" repository should( not)? exist$/ do |repo, negation|
-  repo_path = get_test_repo_path(repo)
-  raise_error_based_on_condition(Laravel::has_laravel?(repo_path), negation)
+  @app_tester = Laravel::AppTests.new(nil, repo)
+  @app_tester.raise_error?(@app_tester.app.has_cache?, negation)
 end
 
-# check if laravel application exists in the given directory
+# This test checks if a Laravel application exists (or was created) in the given
+# directory. It does so by calling the 'has_laravel?' method on the application.
+#
 Then /^laravel application must( not)? exist in "(.*?)" directory$/ do |negation, dir|
-  dir = get_relative_path_to_test_directory(dir)
-  raise_error_based_on_condition(Laravel::has_laravel?(dir), negation)
+  @app_tester = Laravel::AppTests.new(dir)
+  @app_tester.raise_error?(@app_tester.app.has_laravel?, negation)
 end
 
-# check if valid permissions were set on the "storage/" directory
+# This test checks if valid permissions were set on the "storage/" directory
+# This test checks if the valid permissions were set on the "storage/" directory
+# of the application.
+#
 Then /^permissions should( not)? be updated on "(.*?)" directory$/ do |negation, dir|
+  @app_tester = Laravel::AppTests.new(dir)
   step "the stdout should contain \"Updated permissions\"" unless negation
-  dir = get_relative_path_to_test_directory(dir)
-  world_bit = sprintf("%o", File.stat(dir).mode).to_s[-1,1].to_i
+  world_bit = sprintf("%o", File.stat(@app_tester.app_dir).mode).to_s[-1,1].to_i
   is_world_writable = [2,3,6,7].include?(world_bit)
-  raise_error_based_on_condition(is_world_writable, negation)
+  @app_tester.raise_error?(is_world_writable, negation)
 end
 
-# check if application index was set
-Then /^application index must be set to "(.*?)" for "(.*?)" application$/ do |new_index, app_directory|
-  step "the stdout should contain \"Changed Application Index\""
-  check_config_file_for_string("'index' => '#{new_index}'", app_directory)
+# This test checks if the given configuration setting has been updated to a given
+# value for the specified application.
+#
+Then /^configuration: "(.*?)" must be updated to "(.*?)" for "(.*?)" application$/ do |config, value, app_dir|
+  value = '.*' if value == "__something__"
+  @app_tester = Laravel::AppTests.new(app_dir)
+  @app_tester.validate_configuration("'#{config}' => '#{value}'")
+  step "the stdout should contain \"Updated configuration: #{config}\""
 end
 
-# check if application key was set
-Then /^application key must(| not) be set for "(.*?)" application$/ do |negation, app_directory|
-  step "the stdout should contain \"Generated a new key\"" unless negation
-  key_regex = negation.empty? ? "[0-9a-f]{32}" : "YourSecretKeyGoesHere!"
-  check_config_file_for_string("'key' => '#{key_regex}'", app_directory)
-end
-
-# check if generator tasks were setup
-Then /^generator tasks should be setup for "(.*?)" application$/ do |dir|
-  step "the stdout should contain \"Downloaded Laravel Generator by Jeffrey Way\""
-  dir = get_relative_path_to_test_directory(dir)
-  generator_tasks_file = File.join(dir, %w[ application tasks generate.php])
-  raise_error_based_on_condition(File.exists?(generator_tasks_file))
-  unless `which php`.empty?
-    artisan = File.join(dir, "artisan")
-    step "I run `php #{artisan} generate`"
-    step "the stdout should contain \"generate\""
-    step "the stdout should not contain \"Sorry\""
-  end
+# This test checks if the given resource has been installed in the specified
+# application.
+#
+Then /^(.*?): "(.*?)" should be installed (?:as|in) "(.*?)" for "(.*?)" application$/ do |type, name, filename, app_dir|
+  @app_tester = Laravel::AppTests.new(app_dir)
+  filepath = @app_tester.app.tasks_file(filename) if type == "task"
+  @app_tester.raise_error?(File.exists?(filepath))
+  step "the stdout should contain \"Installed #{type}: #{name.capitalize}\""
 end