laravel 0.1.1 → 0.1.3

data/README.md

@@ -1,9 +1,9 @@
 # Laravel
 
-A wrapper around Laravel framework for PHP.  
+A wrapper around Laravel framework for PHP.
 Currently, is only capable of downloading Laravel source from
 a local directory, some git based (online/offline) repository
-or from the official source on Github.  
+or from the official source on Github.
 Still in development.
 
 [![Code
@@ -42,25 +42,35 @@ cached!
 
     # use default settings (fetches source from http://github.com/laravel/laravel.git)
     laravel new my_app
-    
+
     # force a clean install on existing directory
     laravel new my_app --force
-    
+
     # use an existing (already downloaded) source
     laravel new my_app --local=/usr/src/laravel
 
     # use a remote repository
     laravel new my_app --remote="http://github.com/user/my_laravel_fork"
-    
+
     # 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
+
 ### 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
-    
+
+    # 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
+
 ### Help
 
     laravel help
@@ -68,7 +78,7 @@ cached!
 ## Coming Soon..
     # create and customize a new Laravel application
     <del>laravel new my_app --index=''           # set application index to blank</del>
-    laravel new my_app --[no-]key           # generate a new key
+    <del>laravel new my_app --key                # generate a new key<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

data/bin/laravel

@@ -27,9 +27,11 @@ module Laravel
     # default  => create a bare bone Laravel application
     # --local  => use a local directory for source
     # --remote => use a remote git repository for source
-    # --index  => update Application Index for newly created application
     # --force  => overwrite target directory, if it exists
-    desc "new [MY_APP]", "install a new Laravel application"
+    # --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",
@@ -37,6 +39,9 @@ module Laravel
     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 :no_perms, :type => :boolean, :desc => "do not update permissions on storage/ directory"
     def new(app_name)
       Laravel::Create::source app_name, options
     end
@@ -50,6 +55,13 @@ module Laravel
       Laravel::Manage::update_index new_index, options[:app]
     end
 
+    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
+
     # choose a default task to run
     default_task :info
 

data/features/S_1_new.feature

@@ -0,0 +1,58 @@
+Feature: Create a new application based on Laravel framework for PHP
+  In order to develop awesome web application
+  As a PHP developer acquinted with ruby
+  I want to use Laravel gem to setup Laravel framework
+
+  @requires_repository_download @very_slow
+  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
+  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
+  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`
+    Then  laravel application should be ready to use in "my_app" directory using "pastes" repository
+
+  @requires_repository_download
+  Scenario: create Laravel application using non-laravel repository
+    When  I run `laravel new my_app --remote=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"
+    And   laravel application must not exist in "my_app" directory
+
+  @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`
+    Then  laravel application should be ready to use in "my_app" directory using "pastes" repository
+
+  @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`
+    Then  laravel application should be ready to use in "my_app" directory
+
+  @may_require_repository_download
+  Scenario: create Laravel application but do not update permissions on storage/ directory
+    When  I run `laravel new my_app --no_perms`
+    Then  the stdout should contain "Hurray!"
+    And   laravel application must exist in "my_app" directory
+    And   permissions should not be updated on "storage" directory
+
+  @may_require_repository_download
+  Scenario: create Laravel application with maximum customizations
+    When I run `laravel new -ki '' -r http://github.com/laravel/pastes my_app --force`
+    Then laravel application should be ready to use in "my_app" directory
+    And  the stdout should contain "Creating application forcefully"
+    And  the stdout should contain "Generated a new key"
+    And  the stdout should contain "Changed Application Index"

data/features/S_2_generate_key.feature

@@ -0,0 +1,18 @@
+Feature: Generate a new key for Laravel application
+  In order to make the Laravel application more secure
+  As a PHP developer acquinted with ruby
+  I want to use Laravel gem to generate a key
+
+  @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  the stdout should contain "Generated a new key"
+    And   application key must be set 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

data/features/{update_index.feature → S_3_update_index.feature}

@@ -1,7 +1,7 @@
-Feature: Laravel 'update_index'
-  In order to update Application Index in a Laravel application
+Feature: Update Application Index for a Laravel based application
+  In order to have pretty links in my web application
   As a PHP developer acquinted with ruby
-  I want to use Laravel gem
+  I want to use Laravel gem to update Application Index for this application
 
   @may_require_repository_download
   Scenario: update Application Index in a Laravel application
@@ -13,7 +13,5 @@ Feature: Laravel 'update_index'
   @may_require_repository_download
   Scenario: create Laravel application without an Application Index
     When  I run `laravel new my_app --index=''`
-    Then  local cache for "official" repository should exist
-    And   the stdout should contain "Hurray!"
-    And   laravel application must be created inside "my_app" directory
+    Then  laravel application should be ready to use in "my_app" directory
     And   application index must be set to "" for "my_app" application

data/features/step_definitions/laravel.rb

@@ -1,34 +1,80 @@
-# existance of local cache
-Given /^local cache exists for "(.*?)" repository$/ do |repo|
+# suppress any output from Thor based shell while testing
+module Laravel
+  def self.say(status, message = "", log_status = true)
+  end
+end
+
+#### GIVEN ####
+# local cache exists
+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)
-  # easiest method to ensure local cache exists is to clone repo from github
-  unless Laravel::has_laravel?(repo_path)
+  if negation
     FileUtils.rm_rf repo_path
-    `git clone #{repo_url} #{repo_path} &>/dev/null`
+  else
+    # 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
   end
 end
 
-Given /^local cache does not exist for "(.*?)" repository$/ do |repo|
-  repo_path = get_test_repo_path(repo)
-  FileUtils.rm_rf repo_path
+# laravel exists in directory
+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)
+end
+
+# laravel has been downloaded in 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
+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!\""
+  step "laravel application must exist in \"#{dir}\" directory"
+  step "permissions should be updated on \"storage\" directory"
+end
+
+# check if we have a running Laravel instance using 'non-official' repository
+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!\""
+  step "laravel application must exist in \"#{dir}\" directory"
+  step "permissions should be updated on \"storage\" directory"
 end
 
-Then /^local cache for "(.*?)" repository should exist$/ do |repo|
+# check if local cache exists
+Then /^local cache for "(.*?)" repository should( not)? exist$/ do |repo, negation|
   repo_path = get_test_repo_path(repo)
-  Laravel::has_laravel?(repo_path)
+  raise_error_based_on_condition(Laravel::has_laravel?(repo_path), negation)
 end
 
-# download related
-Given /^laravel source has already been downloaded in "(.*?)" directory$/ do |dir|
-  default_repo = get_test_repo_path("official")
+# check if laravel application exists in the given directory
+Then /^laravel application must( not)? exist in "(.*?)" directory$/ do |negation, dir|
   dir = get_relative_path_to_test_directory(dir)
-  # creating new default app is virtually same as downloading the source code
-  Laravel::Create::source(dir, :force => true, :quiet => true) unless Laravel::has_laravel?(dir)
+  raise_error_based_on_condition(Laravel::has_laravel?(dir), negation)
 end
 
-# suppress any output from Thor based shell while testing
-module Laravel
-  def self.say(status, message = "", log_status = true)
-  end
+# check if valid permissions were set on the "storage/" directory
+Then /^permissions should( not)? be updated on "(.*?)" directory$/ do |negation, dir|
+  dir = File.join(get_relative_path_to_test_directory(dir), "storage")
+  is_world_writable = File.world_writable?(dir)
+  raise_error_based_on_condition(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|
+  check_config_file_for_string("'index' => '#{new_index}'", app_directory)
+end
+
+# check if application key was set
+Then /^application key must(| not) be set for "(.*?)" application$/ do |negation, app_directory|
+  key_regex = negation.empty? ? "[0-9a-f]{32}" : "YourSecretKeyGoesHere!"
+  check_config_file_for_string("'key' => '#{key_regex}'", app_directory)
 end

data/features/support/laravel_helpers.rb

@@ -1,11 +1,13 @@
 module LaravelHelpers
   TestDirectory = File.expand_path(File.join(File.dirname(__FILE__), %w[ .. .. tmp aruba]))
 
+  # get the relative path of a directory relative to the temporary path aruba creates
   def get_relative_path_to_test_directory(dir, relative_to = nil)
     relative_to = TestDirectory unless relative_to
     File.expand_path(dir, relative_to)
   end
 
+  # get the url to the repository by its name
   def get_test_repo_url(repo = nil)
     case repo
     when nil, "official", "default" then Laravel::OfficialRepository
@@ -15,10 +17,24 @@ module LaravelHelpers
     end
   end
 
+  # get the full path to the repository by its name
   def get_test_repo_path(repo = nil, repo_url = nil)
     repo_url = get_test_repo_url(repo) unless repo_url
     Laravel::crypted_path(repo_url)
   end
+
+  # checks if the configuration file contains a particular string
+  def check_config_file_for_string(search, dir)
+    dir = get_relative_path_to_test_directory(dir)
+    config_file = File.join(dir, %w[ application config application.php ])
+    raise RSpec::Expectations::ExpectationNotMetError unless File.readlines(config_file).grep(/#{search}/).any?
+  end
+
+  # raises an error based on a condition and negation
+  # if negation is not supplied, simply raises an error if condition is not true
+  def raise_error_based_on_condition(condition, negate = nil)
+    raise RSpec::Expectations::ExpectationNotMetError if condition == !negate.nil?
+  end
 end
 
 World(LaravelHelpers)

data/lib/laravel/create.rb

@@ -4,7 +4,7 @@ module Laravel
     #
     # When downloading from remote repositories, it checks to see if we have
     # previously used that repository (can be the official Laravel source or
-    # forked one). If so, it updates the local copy of that repository and 
+    # forked one). If so, it updates the local copy of that repository and
     # installs from it. Otherwise, it creates a local copy of the repository
     # so that future installs from that repository are instant.
     #
@@ -46,8 +46,18 @@ module Laravel
       # make necessary changes for the new app, if we were successful in download
       # otherwise, remove the downloaded source
       if Laravel::has_laravel? path
+        storage_directory = File.join(path, "storage")
         Laravel::say_success "Cloned Laravel repository."
+        unless options.has_key?("no_perms")
+          response = system("chmod -R o+w #{storage_directory}")
+          if response
+            Laravel::say_success "Updated permissions on storage/ directory."
+          else
+            Laravel::say_failed "Could not update permissiosn on storage/ directory."
+          end
+        end
         Laravel::Manage::update_index options[:index], path if options.has_key?("index")
+        Laravel::Manage::generate_key path if options.has_key?("key")
         Laravel::say_success "Hurray! Your Laravel application has been created!"
       else
         Laravel::say_failed "Downloaded source is not Laravel framework or a possible fork."

data/lib/laravel/info.rb

@@ -1,5 +1,7 @@
 module Laravel
   INFO = '''
+  Run `laravel help` for more details
+
   Create a new Laravel application
   ================================
     laravel new my_app
@@ -12,6 +14,10 @@ module Laravel
       # use a remote repository
     laravel new my_app --index=home.php
       # use default settings and update Application Index
+    laravel new my_app --key
+      # use default settings and generate a new key
+    laravel new my_app --no_perms
+      # use default settings but do not update permissions on storage/ directory
 
   Update Application Index on existing Laravel applications
   =========================================================
@@ -19,5 +25,12 @@ module Laravel
       # in the current directory
     laravel update_index "" --app=./laravel
       # for application in the specified directory
+
+  Generate a key on existing Laravel applications
+  ===============================================
+    laravel generate_key
+      # in the current directory
+    laravel generate_key --app=./laravel
+      # for application in the specified directory
   '''
 end

data/lib/laravel/manage.rb

@@ -6,11 +6,39 @@ module Laravel
     #   - +new_index+ -> the new Application Index
     #   - +app_directory+ -> the directory of the Laravel app, defaults to current working directory
     #
-    def self.update_index(new_index, app_directory = '')
+    def self.update_index(new_index, app_directory = nil)
+      if change_configuration(/'index' => '.*'/, "'index' => '#{new_index}'", app_directory)
+        Laravel::say_success "Changed Application Index."
+      else
+        Laravel::say_failed "Could not change Application Index!"
+      end
+    end
+
+    # generates a new key for the application
+    #
+    # * *Args*    :
+    #   - +app_directory+ -> the directory of the Laravel app, defaults to current working directory
+    #
+    def self.generate_key(app_directory = nil)
+      # 32 char long md5-ed hash
+      new_key = (0...32).map{ ('a'..'z').to_a[rand(26)] }.join
+      new_key = Laravel::crypted_name(new_key)
+
+      # show an appropriate message to the user.
+      if change_configuration(/'key' => '.*'/, "'key' => '#{new_key}'", app_directory)
+        Laravel::say_success "Generated a new key."
+      else
+        Laravel::say_failed "Could not generate a new key!"
+      end
+    end
+
+    private
+
+    def self.change_configuration(match, replace, app_directory = nil)
       # default to current working directory if path is not specified
       app_directory ||= Dir.pwd
 
-      # try to change index only if this is a Laravel application
+      # try to change configuration only if this is a Laravel application
       if Laravel::has_laravel? app_directory
         # file path to the configuration file
         config_file = %w[ application config application.php ]
@@ -18,19 +46,11 @@ module Laravel
 
         # perform substitution
         text = File.read config_file
-        text = text.gsub(/'index' => '.*'/, "'index' => '#{new_index}'")
+        text = text.gsub(match, replace)
         File.open(config_file, "w") {|file| file.puts text}
 
-        # check to ensure we were able to update index
-        check = File.readlines(config_file).grep(/'index' => '#{new_index}'/).any?
-
-        # show an appropriate message to the user.
-        if check
-          Laravel::say_success "Changed Application Index."
-        else
-          Laravel::say_failed "Could not change Application Index!"
-        end
-
+        # check to ensure we were able to update configuration
+        File.readlines(config_file).grep(/#{replace}/).any?
       else
         Laravel::say_error "Is this a valid Laravel application?"
       end

data/lib/laravel/version.rb

@@ -1,3 +1,3 @@
 module Laravel
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: laravel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -74,13 +74,12 @@ files:
 - README.md
 - Rakefile
 - bin/laravel
-- features/new.feature
+- features/S_1_new.feature
+- features/S_2_generate_key.feature
+- features/S_3_update_index.feature
 - features/step_definitions/laravel.rb
-- features/step_definitions/new.rb
-- features/step_definitions/update_index.rb
 - features/support/env.rb
 - features/support/laravel_helpers.rb
-- features/update_index.feature
 - laravel.gemspec
 - lib/laravel.rb
 - lib/laravel/create.rb
@@ -116,10 +115,9 @@ summary: This gem is a wrapper around the Laravel framework for PHP. Initially,
   gem would allow to create new laravel apps along with options to modify the default
   behavior for these new installations.
 test_files:
-- features/new.feature
+- features/S_1_new.feature
+- features/S_2_generate_key.feature
+- features/S_3_update_index.feature
 - features/step_definitions/laravel.rb
-- features/step_definitions/new.rb
-- features/step_definitions/update_index.rb
 - features/support/env.rb
 - features/support/laravel_helpers.rb
-- features/update_index.feature

data/features/new.feature

@@ -1,50 +0,0 @@
-Feature: Laravel 'new'
-  In order to create a new application based on Laravel framework
-  As a PHP developer acquinted with ruby
-  I want to use Laravel gem
-
-  @requires_repository_download @very_slow
-  Scenario: create Laravel application with default settings
-    Given local cache does not exist for "official" repository
-    When  I run `laravel new my_app`
-    Then  local cache for "official" repository should exist
-    And   the stdout should contain "Hurray!"
-    And   laravel application must be created inside "my_app" directory
-
-  @requires_repository_download
-  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`
-    Then  local cache for "pastes" repository should exist
-    And   the stdout should contain "Hurray!"
-    And   laravel application must be created inside "my_app" directory
-
-  @may_require_repository_download
-  Scenario: create Laravel application using repository from local cache
-    Given local cache exists for "official" repository
-    When  I run `laravel new my_app --remote=http://github.com/laravel/pastes`
-    Then  the stdout should contain "Hurray!"
-    And   laravel application must be created inside "my_app" directory
-
-  @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`
-    Then  the stdout should contain "Hurray!"
-    And   laravel application must be created inside "my_app" directory
-
-  @requires_repository_download
-  Scenario: create Laravel application using non-laravel repository
-    When  I run `laravel new my_app --remote=http://github.com/github/gitignore`
-    Then  local cache for "non_laravel" repository should not be created
-    And   the stdout should contain "source is corrupt"
-    And   the stdout should contain "ERROR"
-    And   laravel application must not be created inside "my_app" directory
-
-  @may_require_repository_download
-  Scenario: create Laravel application in the current directory
-    When  I run `laravel new . --force`
-    Then  the stdout should contain "Hurray!"
-    And   laravel application must be created inside current directory
-    When  I run `laravel new .`
-    Then  the stdout should contain "ERROR"

data/features/step_definitions/new.rb

@@ -1,26 +0,0 @@
-# creation of applications
-Then /^laravel application must be created inside "(.*?)" directory$/ do |dir|
-  dir = get_relative_path_to_test_directory(dir)
-  Laravel::has_laravel?(dir)
-end
-
-Then /^laravel application must not be created inside "(.*?)" directory$/ do |dir|
-  dir = get_relative_path_to_test_directory(dir)
-  !File.exists?(dir)
-end
-
-Then /^laravel application must be created inside current directory$/ do
-  dir = File.expand_path(Dir.pwd)
-  Laravel::has_laravel?(dir)
-end
-
-Then /^local cache for "(.*?)" repository should not be created$/ do |repo|
-  repo = get_test_repo_path(repo)
-  !File.exists?(repo)
-end
-
-# suppress any output from Thor based shell while testing
-module Laravel
-  def self.say(status, message = "", log_status = true)
-  end
-end

data/features/step_definitions/update_index.rb

@@ -1,16 +0,0 @@
-Given /^laravel application exists in "(.*?)" directory$/ do |dir|
-  dir = get_relative_path_to_test_directory(dir)
-  Laravel::Create::source(dir) unless Laravel::has_laravel?(dir)
-end
-
-Then /^application index must be set to "(.*?)" for "(.*?)" application$/ do |new_index, dir|
-  dir = get_relative_path_to_test_directory(dir)
-  config_file = File.join(dir, %w[ application config application.php ])
-  File.readlines(config_file).grep(/'index' => '#{new_index}'/).any?
-end
-
-# suppress any output from Thor based shell while testing
-module Laravel
-  def self.say(status, message = "", log_status = true)
-  end
-end