laravel 0.5.1 → 0.7.0

data/.gitignore

@@ -16,6 +16,3 @@ test/tmp
 test/version_tmp
 tmp
 .rvmrc
-repositories/*
-!.gitkeep
-__tests

data/README.md

@@ -29,11 +29,11 @@ Or install it yourself as:
 ### Create a new Laravel application
 
 Laravel gem has a caching mechanism in-built, which allows to keep a local
-copy when you use the remote repositories for the first time. After this,
-whenever you use the remote repository again, it will only update the local
+copy when you use a repository for the first time. After this, whenever you
+use that repository again, it will only update the local copy of the
 repository (as opposed to a fresh git clone, which is considerably slow for
-certain connections). This will, further, allow you to install Laravel
-applications even when you are not connected to the Internet.
+certain connections). This will, allow you to install Laravel applications
+even when you are not connected to the Internet.
 
 Since, you can specify which git repository to use to fetch the Laravel
 source, you can create new Laravel application based on your own or someone
@@ -42,61 +42,55 @@ cached!
 
     # use default settings (fetches source from http://github.com/laravel/laravel.git)
     laravel new my_app
+    laravel new my_app --[no-]force # force overwrite
+    laravel new my_app --[no-]perms # (default) make "storage" directory world-writable
 
-    # force a clean install on existing directory
-    laravel new my_app --force
+    # use a specified repository
+    laravel new my_app --sourec=./src/laravel  # relative directory
+    laravel new my_app --source=/usr/src/local # absolute directory
+    laravel new my_app --source="http://github.com/user/my_laravel_fork # a git repository
 
-    # use an existing (already downloaded) source
-    laravel new my_app --local=/usr/src/laravel
+### Create a customized Laravel application
 
-    # use a remote repository
-    laravel new my_app --remote="http://github.com/user/my_laravel_fork"
+When creating a new Laravel application, we can define configuration settings
+using the '--config' flag. We can pass a comma-separated list of
+`setting:value` pairs, like the following. Note that, you can generate a new
+application key by, simply, passing `key` instead of `key:some_fixed_key`.
 
-    # use default settings and update Application Index
-    laravel new my_app --index='home.php'
-
-    # use default settings and generate a new key
-    laravel new my_app --key
-
-    # use default settings but do not update permissions on storage/ directory
-    laravel new my_app --no-perms
-
-    # use default settings and download Laravel Generator by Jeffrey Way
-    laravel new my_app --generator
+    # generate a new key, set index to empty and turn on the profiler
+    laravel new my_app --config=key,index:'',profiler:on
+    
+    # use a key, set index to "home.php", and update application's language to 'hi'
+    laravel new my_app --config=key:fixed_string,index:home.php,language:hi
 
     # the settings I use:
-    laravel new my_app --key --generator --index=''
+    laravel new my_app --config=key,index:''
     ## this creates a Laravel application from the official repository,
     ## sets the Application Index to blank, makes the storage directory
-    ## world-writable, generates a new key for the application and finally
-    ## sets up the :generate tasks by downloading Laravel Generator.
+    ## world-writable, generates a new key for the application.
     ## Furthermore, this creates the local cache for the official repository
     ## which makes the future installs quite faster :)
 
 ### In an existing Laravel application
 
     # update Application Index for the application
-    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
+    laravel config update index ''  # removes application index for app in current directory
+    laravel config update index 'home.php' --app=./new_app # update for app in specified directory
 
     # generate a new key for the application
-    laravel config key # generates key for app in current directory
-    laravel config key --app=./new_app # generate key for app in specified directory
+    laravel config update key # generates key for app in current directory
+    laravel config update key 'fixed_string' --app=./new_app # set a key for app in specified directory
     
-    # download the Laravel generator by Jeffrey Way
-    laravel install generator --app=./new_app
-
 ### Help
 
     laravel help
 
 ## 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 --[no-]generator     # download the Laravel Generator by Jeffrey Way</del>
+    <del>laravel new my_app --config:index=''           # set application index to blank</del>
+    <del>laravel new my_app --config:key                # generate a new key</del>
+    laravel new my_app --[no-]generator     # download the Laravel Generator by Jeffrey Way
     laravel new my_app --database=db_my_app # create a database, defaults to app name
-    laravel new my_app --bundles=sentry,bob # install the provided bundles
 
 ## Contributing
 

data/Rakefile

@@ -2,8 +2,9 @@ require "bundler/gem_tasks"
 require 'cucumber'
 require 'cucumber/rake/task'
 
+# setup some default rake tasks using cucumber
 Cucumber::Rake::Task.new(:features) do |t|
-    t.cucumber_opts = "features --format pretty"
+    t.cucumber_opts = "features --format progress --tags=~@php"
 end
 
 task :default => :features

data/bin/commands/config.rb

@@ -5,32 +5,57 @@ module Laravel
     # This class inherits from thor and can be used to configure
     # various options in the application/config/application.php file.
     class Config < Thor
-      class_option :debug, :type => :boolean
-
       # 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.
+      # Enable debugger by passing this switch
+      class_option :debug, :type => :boolean
+
+      # This task update a configuration setting for an existing application.
+      # By default, it updates configuration for the application in the current
+      # directory, but this can be overridden by passing +app+ option. It takes
+      # a KEY and a VALUE pair and updates the configuration specified by KEY
+      # to VALUE.
       #
-      desc "index [NEW_INDEX]", "modify the Application Index for Laravel application"
-      def index(new_index)
-        @config = Laravel::Configuration.new(options[:app])
+      # ==== Parameters
+      # +key+   :: [STRING] name of a configuration setting found in the
+      #            application/config/application.php file. It can be one of the
+      #            following values: url, asset_url, index, key, profiler,
+      #            encoding, language, or ssl.
+      #            Settings: languages and aliases are not supported.
+      # +value+ :: [STRING] updated value for this configuration setting.
+      #            Configurations that take a boolean value (currently, profiler
+      #            and ssl) can take one of the following values to specify truth:
+      #            active, on, activated, enable, enabled, true or 1 - everything
+      #            else specifies a falsy value.
+      desc "update [KEY] [VALUE]", "update the configuration [KEY] to [VALUE]"
+      def update(key, value="")
         begin
-          @config.update_index new_index
+          config = Laravel::Configuration.new(options[:app])
+          config.update key, value
         rescue StandardError => e
           Laravel::handle_error e, options[:debug]
         end
       end
 
-      # This task generates a new key for our application.
+      # This task reads the current value of a configuration setting for an
+      # existing application.  By default, it reads configuration for the
+      # application in the current directory, but this can be overridden by
+      # passing +app+ option.
       #
-      desc "key", "generate a new key for Laravel application"
-      def key(value=nil)
-        @config = Laravel::Configuration.new(options[:app])
+      # ==== Parameters
+      # +key+   :: [STRING] name of a configuration setting found in the
+      #            application/config/application.php file. It can be one of the
+      #            following values: url, asset_url, index, key, profiler,
+      #            encoding, language, or ssl.
+      #            Settings: languages and aliases are not supported.
+      desc "get [KEY]", "retrieve the configuration [KEY]"
+      def get(key)
         begin
-          @config.update_key
+          config = Laravel::Configuration.new(options[:app])
+          config.read key
         rescue StandardError => e
           Laravel::handle_error e, options[:debug]
         end

data/bin/commands/new.rb

@@ -1,7 +1,5 @@
 module Laravel
   class CLI < Thor
-    class_option :debug, :type => :boolean
-
     # 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
@@ -23,8 +21,7 @@ module Laravel
     # +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.
+    # +config+   :: [STRING] A comma-separated list of `key-value` pairs - read docs for more information
     # +generator+:: [BOOLEAN] If provided, this downloads the Laravel Generator by Jeffrey Way.
     #
     desc "new [MY_APP]", "create a new Laravel application"
@@ -33,20 +30,17 @@ module Laravel
       :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 :config,  :type => :string,  :aliases => "-c",
+      :desc => "configure the application using semi-colon separated list (read docs)"
     method_option :generator, :type => :boolean, :aliases => "-g",
       :desc => "get the Laravel generator by Jeffrey Way"
+    method_option :debug, :type => :boolean
+
     def new(app_name)
-      app = Laravel::App.new(app_name, options)
       begin
-        app.create
+        Laravel::App.new(app_name, options).create
       rescue StandardError => e
         Laravel::handle_error e, options[:debug]
-      rescue Exception => e
-        Laravel::handle_error e, options[:debug]
       end
     end
 

data/bin/laravel

@@ -14,7 +14,6 @@ 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
@@ -26,7 +25,7 @@ module Laravel
     default_task :version
 
     # map some inputs to tasks
-    map "-T" => "help", "-C" => "config", "-I" => "install", "-N" => "new"
+    map "-T" => "help", "-C" => "config"
 
     # config subcommand that manipulates app configuration
     #
@@ -35,13 +34,6 @@ module Laravel
     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.
     #
@@ -54,6 +46,24 @@ module Laravel
       # puts "Made possible by efforts of Laravel Community"
     end
 
+    # run an artisan command using this gem
+    #
+    # +command+ :: command to run using artisan
+    #
+    method_option :app, :type => :string, :aliases => "-a",
+      :desc => "use the specified Laravel application instead of curernt directory"
+    method_option :debug, :type => :boolean
+    desc "do [COMMAND]", "run an 'artisan' command"
+    def do(*args)
+      begin
+        command = args.join ' '
+        app = Laravel::App.new options[:app]
+        app.artisan command
+      rescue StandardError => e
+        Laravel::handle_error e, options[:debug]
+      end
+    end
+
   end
 end
 

data/features/S_0__release.feature

@@ -0,0 +1,13 @@
+Feature: Basic configurations and testing
+  In order to release the gem
+  As an author of this gem
+  I want to test basic configuration for this gem
+
+  @release
+  Scenario: Release the gem
+    Given I want to make sure everything runs before releasing the gem
+    Then  the working directory should not be dirty
+    And   the version should be updated
+    And   the readme should be updated with new information
+    And   the directory with laravel data should not exist
+    And   snapshotted git commits should not exist

data/features/S_3_new_customized.feature

@@ -4,11 +4,33 @@ Feature: Create a new application with maximum customizations
   I want to use Laravel gem to setup a new application with maximum customizations
 
   Scenario: create Laravel application with maximum customizations
-    Given I want to create an application forcefully
-    And   I want to use "http://github.com/laravel/pastes" as source
+    Given no application has been created using "http://github.com/laravel/laravel" as source
+    And   I want to create an application forcefully
+    And   I want to use "http://github.com/laravel/laravel" as source
     And   I want to generate a new key
-    And   I want to use "home.php" as application index
+    And   I want to use "home.php" as application "index"
+    And   I want to "enable" the "profiler"
+    And   I want to "disable" the "ssl"
+    And   I want to use "hi" as the "language"
+    And   I want to use "http://pastes.laravel.com" as the application "url"
     When  I create an application with above requirements
     Then  application should be ready for development
     And   a new application key should be generated
-    And   the application index should be updated to "home.php"
+    And   the application "index" should be updated to "home.php"
+    And   the application "url" should be updated to "http://pastes.laravel.com"
+    And   the "ssl" should be turned off
+    And   the "profiler" should be turned on
+    And   the "language" should be updated to "hi"
+
+  Scenario: CLI UI
+    Given applications have been created using "http://github.com/laravel/laravel" as source
+    When  I run `laravel new my_app --force --config=index:'',key --source=http://github.com/laravel/laravel`
+    Then  I should not fail while doing so
+    And   I should see "forcefully"
+    And   I should see "exists in local cache"
+    And   I should see "Updating local cache"
+    And   I should see "Cloned"
+    And   I should see "Updated permissions"
+    And   I should see "Updated configuration: index => __empty_string"
+    And   I should see "Updated configuration: key"
+    And   I should see "Hurray!"

data/features/S_4_config.feature

@@ -8,10 +8,76 @@ Feature: Configure an existing Laravel application
     When  I create this application
     Then  the application should be ready for development
 
+  Scenario: update Application's URL
+    When  I run `laravel config update url "http://laravel.com"` inside this application
+    Then  the application "url" should be updated to "http://laravel.com"
+    
+  Scenario: update Application's asset URL
+    When  I run `laravel config update asset_url "http://laravel.com"` inside this application
+    Then  "asset_url" should be updated to "http://laravel.com"
+
+  Scenario: update Application Index
+    When  I run `laravel config update index "home.php"` inside this application
+    Then  the application "index" should be updated to "home.php"
+
   Scenario: generate a new key for a Laravel application
-    When  I generate a new key for this application
-    Then  a new application key should be generated
+    When  I run `laravel config update key` inside this application
+    Then  an application key should be generated
+
+  Scenario: set a fixed key for a Laravel application
+    When  I run `laravel config update key my_special_key` inside this application
+    Then  the application "key" should be updated to "my_special_key"
+
+  Scenario: turn on/off the profiler for the application
+    When  I run `laravel config update profiler active` inside this application
+    Then  the "profiler" should be turned on
+
+  Scenario: turn on/off the ssl
+    When  I run `laravel config update ssl enabled` inside this application
+    Then  the "ssl" should be turned on
+
+  Scenario: update Application's language
+    When  I run `laravel config update language hi` inside this application
+    Then  the "language" should be updated to "hi"
+
+  Scenario: update Application's encoding
+    When  I run `laravel config update encoding "US-ASCII"` inside this application
+    Then  the "encoding" should be updated to "US-ASCII"
+
+  Scenario: update Application's timezone
+    When  I run `laravel config update timezone "UTC+5:30"` inside this application
+    Then  the "timezone" should be updated to "UTC+5:30"
+
+  Scenario: update supported languages
+    When  I run `laravel config update languages "array('hi', 'en')"` inside this application
+    Then  I should fail while doing so
+
+  Scenario: configuration that are boolean can take multiple arguments
+    # on/off
+    When  I run `laravel config update profiler on` inside this application
+    Then  the "profiler" should be turned on
+    When  I run `laravel config update ssl off` inside this application
+    Then  the "ssl" should be turned off
+    # yes/no
+    When  I run `laravel config update ssl yes` inside this application
+    Then  the "ssl" should be turned on
+    When  I run `laravel config update profiler no` inside this application
+    Then  the "profiler" should be turned off
+    # active/inactive
+    When  I run `laravel config update ssl active` inside this application
+    Then  the "ssl" should be turned on
+    When  I run `laravel config update profiler inactive` inside this application
+    Then  the "profiler" should be turned off
+    # enabled/disabled
+    When  I run `laravel config update profiler enabled` inside this application
+    Then  the "profiler" should be turned on
+    When  I run `laravel config update ssl disabled` inside this application
+    Then  the "ssl" should be turned off
 
-  Scenario: update Application Index in a Laravel application
-    When  I udpate application index to "home.php"
-    Then  the application index should be updated to "home.php"
+  Scenario: can read configuration settings
+    When  I run `laravel config update url "http://laravel.com"` inside this application
+    And   I run `laravel config get url` inside this application
+    Then  I should see "Configuration: url => 'http://laravel.com'"
+    When  I run `laravel config update profiler false` inside this application
+    And   I run `laravel config get profiler` inside this application
+    Then  I should see "Configuration: profiler => false"

data/features/S_5_do.feature

@@ -0,0 +1,14 @@
+Feature: Run artisan commands via gem
+  In order to use the artisan command-line tool
+  As a PHP developer acquinted with ruby
+  I want to use the Laravel gem to call artisan commands
+
+  Background: An application based on Laravel framework exists
+    Given I want to create a new application
+    When  I create this application
+    Then  the application should be ready for development
+
+  @php
+  Scenario: run application tests using artisan
+    When  I run `laravel do test` inside this application
+    Then  I should see "PHPUnit"

data/features/step_definitions/app_steps.rb

@@ -0,0 +1,72 @@
+# failure?
+Then /^I should( not)? fail (?:in|when|while|for) doing so$/ do |negate|
+  step "the stdout should#{negate} contain \"Failed\""
+  step "the stdout should not contain \"ERROR\"" if negate
+end
+
+# error?
+Then /^I should( not)? (?:get|see) an error$/ do |negate|
+  step "the stdout should#{negate} contain \"ERROR\""
+end
+
+# CLI output
+Then /^I should see "(.*?)"$/ do |string|
+  step "the stdout should contain \"#{string}\""
+end
+
+# S_0__release
+# These tests are only run when we plan for releasing the gem, and hence,
+# we are running the full test suite.
+Given /^I want to make sure everything runs before releasing (?:|the |this )gem$/ do
+  data_dir = File.expand_path(File.join(ENV['HOME'], ".laravel"))
+  FileUtils.rm_rf data_dir
+end
+
+# remind me if I have not updated the README.md before a release
+# I create 'feature' branches, which I then merge with 'develop' branch.
+# Hence, README.md should be updated with details of the new feature.
+Then /^the readme should( not)? be updated with new information$/ do |negate|
+  last_tag = `git tag | tail -1`.strip
+  actual   = `git diff #{last_tag}..HEAD -- README.md`.strip
+  expected = !negate
+  message  = "README.md to be updated with new information"
+  unexpected? actual, expected, message
+end
+
+# remind me if I have not updated the version string before a release
+Then /^the version should be updated$/ do
+  current  = "v#{Laravel::VERSION}"
+  all_tags = `git tag`.split("\n").map {|t| t.strip}
+  exists   = all_tags.include? current
+  message  = "laravel version to be #{current} for this release"
+  unexpected_if exists, message
+end
+
+# make sure no local cache exists before we run the full test suite
+Then /^the directory with laravel data should( not)? exist$/ do |negate|
+  data_dir = File.expand_path(File.join(ENV['HOME'], ".laravel"))
+  actual   = File.directory?(data_dir)
+  expected = !negate
+  message  = "#{data_dir} to exist"
+  unexpected? actual, expected, message
+end
+
+# remind me if the working directory is not clean
+Then /^the working directory should( not)? be dirty$/ do |negate|
+  actual   = `git status --porcelain`.strip
+  expected = !negate
+  message  = "working directory to be dirty"
+  unexpected? actual, expected, message
+end
+
+# I have a habit of making quick commits marked by 'snapped' or 'snapshot(|s|ing)'
+# whenever I leave my desk for some personal work.
+# This quickly reminds me if such commits are present in the commit history.
+Then /^snapshotted git commits should( not)? exist$/ do |negate|
+  snapped  = `git log develop.. | grep 'snapped'`.strip
+  snapshot = `git log develop.. | grep 'snapshot'`.strip
+  actual   = snapped || snapshot
+  expected = !negate
+  message  = "commit history to contain snapshots"
+  unexpected? actual, expected, message
+end