laravel 0.2.1 → 0.3.2

data/lib/laravel/configuration.rb

@@ -0,0 +1,119 @@
+module Laravel
+  # This class handles the configuration aspects of a Laravel based
+  # application.  This allows us to read and update settings in
+  # ./application/config/application.php Furthermore, it allows us to read and
+  # update various options, at one go.
+  class Configuration < App
+
+    # This method creates dynamic read/update methods exposed by this class.
+    # For this to work, the exposed functions have a definite naming
+    # convention: {action}_{setting}, where {action} can be either 'read' or
+    # 'update', and {setting} can be one of the settings found in the
+    # configuration file.
+    #
+    # For example: calling: update_index("home.php") will update the 'index'
+    # setting to use 'home.php' also, calling: update_key() will update the
+    # 'key' to a 32-char long string.
+    #
+    # The second example above automatically generates a 32-char string by
+    # calling 'do_update_key' method implicitely, which returns this string.
+    #
+    # The 'do_{method}' methods must be defined in this class, which return the
+    # manipulated input from callee.
+    #
+    def method_missing(name, *args)
+      # capture the input from callee
+      value = args[0]
+
+      # understand what the callee is requesting..
+      dissect = name.to_s.split "_"
+      action  = dissect[0]
+      setting = dissect[1]
+
+      # lets manipulate the input value if a 'do_{method}' exists
+      new_value = method("do_#{name}").call(value) if Configuration.method_defined?("do_#{name}".to_sym)
+      # otherwise, use the passed value without any manipulations
+      new_value = value if new_value.nil? or new_value.strip.empty?
+
+      # handle the {action} part of the method
+      # performs a read/update on the Configuration setting.
+      response = case action
+                 when "read" then __read_config(setting)
+                 when "update" then __update_config(setting, new_value)
+                 else show_error "Do not know how to configure this setting!"
+                 end
+
+      # let the user know when we set the value to an empty string
+      new_value = "__empty_string__" if new_value.nil? or new_value.strip.empty?
+
+      # Let the user know that we have performed an action
+      if response and action != "read"
+        say_success "#{action.capitalize}d configuration: #{setting} => #{new_value}"
+      else
+        say_failed "Could not #{action} configuration: #{setting.capitalize}!"
+      end
+    end
+
+    # update the configuration settings by looking at the options
+    # that the user has provided when running the 'new' task.
+    #
+    def update_from_options
+      # don't do anything, unless options were provided
+      return unless @options
+
+      # update permissions on storage/ directory (this is the default)
+      update_permissions_on_storage if @options[:perms]
+      # update Application Index, if provided
+      update_index @options[:index] unless @options[:index].nil?
+      # generate a new key, if asked for.
+      update_key if @options[:key]
+    end
+
+    # lets generate the random string required by the 'update_key' method
+    #
+    # ==== Parameters
+    # +value+:: optional string, that if provided will be used as the new key
+    #            instead of generating a random one.
+    #
+    # ==== Returns
+    # String:: the new key for the application
+    def do_update_key(value = nil)
+      make_md5
+    end
+
+    private
+
+    # handle the config update routine.
+    # this method first checks to see if the current app is a Laravel
+    # based application, and then performs the update for this setting.
+    # Finally, it checks whether the update was successful and returns it.
+    #
+    # ==== Parameters
+    # +key+:: the configuration setting which will be updated
+    # +new_value:: the new value for the configuration defined by +key+
+    #
+    # ==== Returns
+    # Boolean:: true if the update was successful.
+    #
+    def __update_config(key, new_value)
+      # default to current working directory if path is not specified
+      conf = config_file
+
+      # try to change configuration only if this is a Laravel application
+      # otherwise, raise an error
+      if has_laravel?
+
+        # make the required substitution in the configuration file
+        text = File.read conf
+        text = text.gsub(/'#{key}' => '.*'/, "'#{key}' => '#{new_value}'")
+        File.open(conf, "w") {|file| file.puts text}
+
+        # check to ensure we were able to update configuration
+        File.readlines(conf).grep(/'#{key}' => '#{new_value}'/).any?
+      else
+        show_error "Is this a valid Laravel application?"
+      end
+    end
+
+  end
+end

data/lib/laravel/installer.rb

@@ -0,0 +1,61 @@
+module Laravel
+  # This class handles the installation of certain tasks or some bundles, e.g.
+  # bob, sentry, etc.  Since, these installation do not follow a definite
+  # pattern, we will need to define method that handles a particular
+  # installation.
+  class Installer < App
+
+    # This method acts as a gateway for the installation methods exposed by
+    # this class.  The exposed methods follow a definite naming convention:
+    # {type}_{resource}, where {type} can either be 'task' or 'bundle', and
+    # {resource} is the name of the thing we are trying to install.
+    #
+    # For example: calling: task_generator() will install a task in the
+    # application/tasks/ folder, where 'do_task_generator' method defines how
+    # the particular install wil really be handled.  Please, have a look at the
+    # source code of the above example for more information.
+    #
+    # The 'do_{method}' methods must be defined in this class, which actually
+    # handle the installation routine for us. These methods must have 'boolean'
+    # as their return value.
+    #
+    def method_missing(name, *args)
+      # know what we are doing
+      dissect = name.to_s.split "_"
+      type    = dissect[0]
+      source  = dissect[1]
+
+      # we MUST have a 'do_{method}' defined!!
+      if Installer.method_defined?("do_#{name}".to_sym)
+
+        if method("do_#{name}").call
+          say_success "Installed #{type}: #{source.capitalize}"
+        else
+          say_failed "Could not install #{type}: #{source.capitalize}"
+        end
+      else
+        say_failed "Don't know how to install #{source.capitalize}!"
+      end
+    end
+
+    # install the particular tasks or bundles by looking the options
+    # that the user has provided when running the 'new' task.
+    #
+    def from_options
+      return unless @options
+
+      # read and perform installs from options passed through the command line.
+      task_generator if @options[:generator]
+    end
+
+    # Install the Laravel Generator by Jeffrey Way.  This creates a file named
+    # 'generate.php' in the application/tasks/ folder, which can be invoked as:
+    # `php artisan generate` using artisan.
+    #
+    def do_task_generator
+      url  = "https://raw.github.com/JeffreyWay/Laravel-Generator/master/generate.php"
+      # download the Laravel Generator using curl as 'generate.php'
+      download_resource(tasks_file("generate.php"), url, "curl")
+    end
+  end
+end

data/lib/laravel/version.rb

@@ -1,3 +1,3 @@
 module Laravel
-  VERSION = "0.2.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: laravel
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-22 00:00:00.000000000 Z
+date: 2012-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -73,6 +73,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/commands/config.rb
+- bin/commands/install.rb
+- bin/commands/new.rb
 - bin/laravel
 - features/S_1_new.feature
 - features/S_2_generate_key.feature
@@ -83,12 +86,11 @@ files:
 - features/support/laravel_helpers.rb
 - laravel.gemspec
 - lib/laravel.rb
-- lib/laravel/create.rb
-- lib/laravel/helpers.rb
-- lib/laravel/info.rb
-- lib/laravel/manage.rb
+- lib/laravel/app.rb
+- lib/laravel/app_support.rb
+- lib/laravel/configuration.rb
+- lib/laravel/installer.rb
 - lib/laravel/version.rb
-- repositories/.gitkeep
 homepage: https://github.com/nikhgupta/laravel
 licenses: []
 post_install_message: 
@@ -103,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3710655952266878729
+      hash: 3739253093214665675
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -112,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3710655952266878729
+      hash: 3739253093214665675
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/laravel/create.rb

@@ -1,121 +0,0 @@
-module Laravel
-  class Create
-    # This method downloads the Laravel source files.
-    #
-    # 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
-    # installs from it. Otherwise, it creates a local copy of the repository
-    # so that future installs from that repository are instant.
-    #
-    # * *Args*    :
-    #   - +path+ -> path to the destination
-    # * *Returns* :
-    #   - string containing error message, if any or is otherwise nil
-    #
-    def self.source(path, options = {})
-      # get some information about this path
-      path = File.expand_path(path)
-      is_current_dir = (path == File.expand_path('.'))
-      is_not_empty   = (Dir.entries(path).size > 2) if File.exists?(path)
-
-      # make sure that the path does not already exists (no overwrites!)
-      if ((File.exists?(path) and not is_current_dir) or (is_current_dir and is_not_empty)) and not options[:force]
-        Laravel::say_error "directory already exists or is not empty!"
-      end
-
-      # delete the existing files, if we are forced for this
-      if options[:force]
-        Laravel::say_info "Creating application forcefully!"
-        is_current_dir ? FileUtils.rm_rf("#{path}/.", :secure => true) : FileUtils.rm_rf(path)
-      end
-
-      # create the requisite directory structure
-      FileUtils.mkdir_p File.dirname(path) unless is_current_dir
-
-      # download/update local repository as required
-      local_repo_for_remote_path = options[:local] || self.local_repository(options)
-
-      # copy the Laravel source to the required path
-      if is_current_dir
-        FileUtils.cp_r "#{local_repo_for_remote_path}/.", path
-      else
-        FileUtils.cp_r local_repo_for_remote_path, path
-      end
-
-      # make necessary changes for the new app, if we were successful in download
-      # otherwise, remove the downloaded source
-      if Laravel::has_laravel? path
-        Laravel::say_success "Cloned Laravel repository."
-        if options[:perms]
-          storage_directory = File.join(path, "storage")
-          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::Manage::get_generator path if options.has_key?("generator")
-        Laravel::say_success "Hurray! Your Laravel application has been created!"
-      else
-        Laravel::say_failed "Downloaded source is not Laravel framework or a possible fork."
-        Laravel::say_info "Cleaning up.."
-        FileUtils.rm_rf "#{path}" unless is_current_dir
-        # delete_corrupted = Laravel::yes? "Should I delete the specified repository from local cache? (default: yes)"
-        # if delete_corrupted
-          # Laravel::say_info "Deleting local cache for this source!"
-          # FileUtils.rm_rf "#{local_repo_for_remote_path}"
-        # else
-          # Laravel::say_info "Local cache for this source was not deleted!"
-        # end
-        FileUtils.rm_rf "#{local_repo_for_remote_path}"
-        Laravel::say_error "Specified Laravel source is corrupt!"
-      end
-    end
-
-    # Create or update local repository whenever a remote source is specified.
-    #
-    # * *Args*    :
-    #   - +options+ -> arguments passed from other tasks, if any.
-    # * *Returns* :
-    #   - boolean depending on whether a download/update was done or not
-    #
-    def self.local_repository(options = {})
-      # do not attempt download/update if user specifically wants to stay offline
-      return if options.has_key?("local")
-
-      # prefer remote path, if specifically supplied by user
-      # otherwise, default to the official repository
-      remote_repo = options[:remote] || Laravel::OfficialRepository
-      local_path_for_remote_repo = Laravel::crypted_path remote_repo
-
-      # get the path to the git binary
-      git = `which git`.strip
-
-      # string which will suppress the output of commands in quiet mode
-      # quiet = options[:quiet] ? "&>/dev/null" : "1>/dev/null"
-      quiet = "&>/dev/null"
-
-      # update or download the remote repository
-      FileUtils.mkdir_p local_path_for_remote_repo
-      # say_info "Created requisite directory structure."
-      Dir.chdir local_path_for_remote_repo do
-        # do an update if cache exists, otherwise download it
-        # do this every time before creating new app so that we are always up-to-date
-        if Laravel::local_repository_exists?(remote_repo)
-          Laravel::say_info "Repository exists in local cache.."
-          Laravel::say_info "Updating repository in local cache.."
-          print `#{git} pull #{quiet}`
-        else
-          Laravel::say_info "Downloading repository to local cache.."
-          print `#{git} clone #{remote_repo} . #{quiet}`
-        end
-      end
-
-      local_path_for_remote_repo
-    end
-  end
-end

data/lib/laravel/helpers.rb

@@ -1,59 +0,0 @@
-require 'digest/md5'
-
-module Laravel
-  LocalRepositories = File.expand_path(File.join(File.dirname(__FILE__), %w[ .. .. repositories ]))
-  OfficialRepository = "http://github.com/laravel/laravel.git"
-
-  # check if the given folder is a laravel source
-  # we check this by looking for presence of 'artisan', 'laravel/', etc.
-  def self.has_laravel?(directory)
-    return false unless File.exists?    File.join( directory, "artisan" )
-    return false unless File.directory? File.join( directory, "laravel" )
-    true
-  end
-
-  # check if local repository exists for a given remote git source
-  def self.local_repository_exists?(source)
-    local_repository_path = Laravel::crypted_path(source)
-    Laravel::has_laravel?(local_repository_path) ? local_repository_path : nil
-  end
-
-  # return the crypted folder name for a given remote repository
-  def self.crypted_name(source)
-    (Digest::MD5.new << source).to_s
-  end
-
-  # return the crypted folder path for a given remote repository
-  def self.crypted_path(source)
-    File.join(Laravel::LocalRepositories, Laravel::crypted_name(source))
-  end
-
-  # ask user for confirmation
-  def self.yes?(message, color=nil)
-    shell = Thor::Shell::Color.new
-    shell.yes?(message, color)
-  end
-
-  # say something to the user.
-  def self.say(status, message = "", log_status = true)
-    shell = Thor::Shell::Color.new
-    shell.say_status(status, message, log_status)
-  end
-
-  def self.say_info(message)
-    self.say "Information", message, :cyan
-  end
-
-  def self.say_success(message)
-    self.say "Success", message, :green
-  end
-
-  def self.say_failed(message)
-    self.say "Failed!!", message, :yellow
-  end
-
-  def self.say_error(message)
-    self.say "!!ERROR!!", message, :red
-    exit
-  end
-end

data/lib/laravel/info.rb

@@ -1,45 +0,0 @@
-module Laravel
-  INFO = '''
-  Run `laravel help` for more details
-
-  Create a new Laravel application
-  ================================
-    laravel new my_app
-      # use default settings
-      # fetches source from http://github.com/laravel/laravel.git
-    laravel new my_app --force
-      # force a clean install on existing directory
-    laravel new my_app --remote="http://github.com/user/my_laravel_fork"
-      # use an existing (already downloaded) source
-      # 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
-    laravel new my_app --generator
-      # use default settings and downloaded Laravel generator by Jeffrey Way
-
-  Update Application Index on existing Laravel applications
-  =========================================================
-    laravel update_index "home.php"
-      # 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
-
-  Download Laraevl Generator by Jeffrey Way
-  =========================================
-    laravel get_generator
-      # in the current directory
-    laravel get_generator --app=./laravel
-      # for application in the specified directory
-  '''
-end