laravel 0.5.1 → 0.7.0

data/lib/laravel/configuration.rb

@@ -3,73 +3,126 @@ module Laravel
   # 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 raise InvalidArgumentError
-                 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}"
+  class Configuration
+    # include Helpers and AppSupport modules that have the helper methods defined
+    include Laravel::Helpers
+    include Laravel::AppSupport
+
+    attr_reader :path, :config
+
+    # Create a new Configuration class, which helps us to configure
+    # an existing Laravel application.
+    #
+    # ==== Parameters
+    # +path+ :: Path to an existing Laravel application, which can
+    # either be relative or an absolute path. If path is not supplied,
+    # we assume current directory.
+    #
+    # +config+ :: It can be a comma-separated string or an array or a hash
+    # of `key:value` pairs. When creating a new app, +config+ is passed as a
+    # comma-separated string.
+    #
+    #   Examples:
+    #     index:"",key,profiler:on,url:http://laravel.com
+    #     index,key:some_secret_key,ssl:enabled
+    #
+    def initialize(path = nil, config = nil)
+      self.path = path
+
+      # try to do anything only if this is a Laravel application
+      # otherwise, raise an error
+      raise LaravelNotFoundError unless has_laravel?
+
+      # set the desired configuration options
+      self.config = config
+
+    end
+
+    # Expand the supplied path for the application.
+    #
+    # ==== Parameters
+    # +path+ :: Path to an existing Laravel application, which can
+    # either be relative or an absolute path. If path is not supplied,
+    # we assume current directory.
+    #
+    def path=(path = nil)
+      path  = Dir.pwd if not path or path.strip.empty?
+      @path = File.expand_path(path)
+    end
+
+    # Create a configuration hash from the supplied input format
+    #
+    # ==== Parameters
+    # +config+ :: It can be a comma-separated string or an array or a hash
+    # of `key:value` pairs. When creating a new app, +config+ is passed as a
+    # comma-separated string.
+    #
+    #   Examples:
+    #     index:"",key,profiler:on,url:http://laravel.com
+    #     index,key:some_secret_key,ssl:enabled
+    #
+    def config=(config = {})
+      @config = config.is_a?(Hash) ? config : {}
+      config  = config.split(",") if config.is_a?(String)
+      if config.is_a?(Array)
+        config.each do |c|
+          c = c.split(":", 2)
+          @config[c[0]] = c[1]
+        end
+      end
+    end
+
+    # Update a configuration setting in the configuration file
+    #
+    # ==== Parameters
+    # +config+ :: one of the configuration settings as provided in the
+    # configuration file for the application
+    #
+    # +value+ :: the new value for the supplied +config+ setting. Note that,
+    # for configuration settings that take a boolean value, you can pass values
+    # like 'true', 'enabled', 'active', 'on', 1 etc. to signify truth.
+    #
+    def update(config, value)
+      return if unsupported? config
+      value   = process_input(config, value)
+      updated = __update_configuration(config, value)
+      value   = "__empty_string__" if is_blank?(value)
+      if updated
+        say_success "Updated configuration: #{config} => #{value}"
       else
-        say_failed "Could not #{action} configuration: #{setting.capitalize}!"
+        say_failed "Could not update configuration: #{config}"
+      end
+    end
+
+    # Reads a configuration setting from the configuration file
+    #
+    # ==== Parameters
+    # +config+ :: one of the configuration settings as provided in the
+    # configuration file for the application
+    #
+    def read(config)
+      return if unsupported? config
+      value = __read_configuration(config)
+      value = "__empty_string__" if is_blank?(value)
+      if value
+        say_success "Configuration: #{config} => #{value}"
+      else
+        say_failed "Could not read configuration: #{config}"
       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
+    def 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]
+      return if not @config or @config.empty?
+      @config.each { |key, value| update(key, value) }
     end
 
-    # lets generate the random string required by the 'update_key' method
+    # Process input when we are configuring the Application Key.
+    # By default, generates a random 32 char string, but if a string is
+    # passed as +value+, returns it without further processing.
     #
     # ==== Parameters
     # +value+:: optional string, that if provided will be used as the new key
@@ -77,16 +130,104 @@ module Laravel
     #
     # ==== Returns
     # String:: the new key for the application
-    def do_update_key(value = nil)
+    #
+    def process_input_for_key(value = nil)
+      return value unless is_blank?(value)
       make_md5
     end
 
+    # Process input when we are configuring the Profiler setting.
+    # Simply checks if the supplied +value+ corresponds to a 'truthy' value
+    # and returns it.
+    #
+    # ==== Parameters
+    # +value+ :: a string that signifies either the truth or false. It can take
+    # multiple values like enabled, active, on, etc. to signify truth.
+    #
+    # ==== Return
+    # +boolean+ :: the new value for the Profiler setting
+    #
+    def process_input_for_profiler(value)
+      __convert_action_to_boolean value
+    end
+
+    # Process input when we are configuring the SSL setting.
+    # Simply checks if the supplied +value+ corresponds to a 'truthy' value
+    # and returns it.
+    #
+    # ==== Parameters
+    # +value+ :: a string that signifies either the truth or false. It can take
+    # multiple values like enabled, active, on, etc. to signify truth.
+    #
+    # ==== Return
+    # +boolean+ :: the new value for the SSL setting
+    #
+    def process_input_for_ssl(value)
+      __convert_action_to_boolean value
+    end
+
     private
 
+    # Check if the supplied +config+ setting is supported, at the moment?
+    # Currently, this class does not support configuration settings that take
+    # a PHP array as their value.
+    #
+    # ==== Parameters
+    # +config+ :: the configuration setting to test
+    #
+    # ==== Return
+    # +boolean+ :: true, if the configuration setting is unsupported
+    #
+    def unsupported?(config)
+      unsupported_configs = [ "languages", "aliases" ]
+      unsupported = unsupported_configs.include? config
+      say_failed "Configuration: #{config} is not supported!" if unsupported
+      unsupported
+    end
+
+    # Process the input +value+ for the given +config+ setting.
+    # The method checks to see if a method exists by the name:
+    # 'process_input_for_{config}' and if so, passes the +value+
+    # to that method for processing, and returns the new value.
+    #
+    # ==== Parameters
+    # +config+ :: the configuration setting that needs the update
+    #
+    # +value+ :: the input value that was supplied when running the task
+    #
+    # ==== Return
+    # +mixed+ :: the new value after processing the given input
+    def process_input(config, value)
+      name = "process_input_for_#{config}"
+      if Configuration.method_defined? name
+        value = method(name).call(value)
+      end
+      value
+    end
+
+    # This method transforms the given input into true or false
+    # so that the user can say things like:
+    #
+    #     laravel config update ssl enabled
+    #     laravel config update profiler active
+    #
+    # ==== Parameters
+    # +value+ :: the input value that was supplied when running the task
+    #
+    # ==== Return
+    # +boolean+ :: the processed input value
+    #
+    def __convert_action_to_boolean(value = nil)
+      on  = [ true, "true", "active", "activated",
+              "enable", "enabled", "yes", "on", "1", 1 ]
+      on.include?(value) ? true : false
+    end
+
     # 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.
+    # this method first makes the required update in the configuration file,
+    # then it checks whether the update was successful? If not, the method
+    # reverts to the old configuration and returns whether we were successful
+    # in making the update or not.
     #
     # ==== Parameters
     # +key+:: the configuration setting which will be updated
@@ -95,22 +236,41 @@ module Laravel
     # ==== Returns
     # Boolean:: true if the update was successful.
     #
-    def __update_config(key, new_value)
-      # default to current working directory if path is not specified
+    def __update_configuration(key, new_value)
       conf = config_file
-
-      # try to change configuration only if this is a Laravel application
-      # otherwise, raise an error
-      raise LaravelNotFoundError unless has_laravel?
+      replace = new_value.is_a?(String) ? "'#{new_value}'" : new_value
+      check   = new_value.is_a?(String) ? Regexp.escape(replace) : replace
 
       # 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}
+      updated_text = text.gsub(/'#{key}' => .*,/, "'#{key}' => #{replace},")
+      File.open(conf, "w") {|file| file.puts updated_text}
 
       # check to ensure we were able to update configuration
-      File.readlines(conf).grep(/'#{key}' => '#{new_value}'/).any?
+      updated = File.readlines(conf).grep(/'#{key}' => #{check},/).any?
+
+      # revert if we could not update the configuration
+      File.open(conf, "w") {|file| file.puts text} unless updated
+
+      # response with a success or failure
+      updated
     end
 
+    # handle the config read routine.
+    #
+    # ==== Parameters
+    # +key+ :: the configuration setting which needs to be read
+    #
+    # ==== Return
+    # +mixed+ :: the current value for the supplied configuration setting
+    #
+    def __read_configuration(key)
+      conf = config_file
+
+      # make the required substitution in the configuration file
+      text  = File.read conf
+      match = text.match(/'#{key}' => (.*),/)
+      match ? match[1] : nil
+    end
   end
 end

data/lib/laravel/errors.rb

@@ -1,55 +1,27 @@
 module Laravel
 
-  class InvalidArgumentError < StandardError
-    def initialize(message = "Invalid arguments specified!")
+  # A general 'Laravel' error.
+  class LaravelError < StandardError
+    def initialize(message = "A general error occurred while processing..")
       super(message)
     end
   end
 
+  # Error to be raised when Laravel is expected in a directory, but not found
   class LaravelNotFoundError < StandardError
     def initialize(message = "Is this a valid Laravel application?")
       super(message)
     end
   end
 
-  class InvalidSourceRepositoryError < StandardError
-    def initialize(message = "Source for downloading Laravel repository is corrupt!")
-      super(message)
-    end
-  end
-
-  class LaravelError < StandardError
-    def initialize(message = "A general error occurred while processing the command!")
-      super(message)
-    end
-  end
-
-  class RequiredForceMissingError < StandardError
-    def initialize(message = "You must pass in --force parameter to force an overwrite!")
-      super(message)
-    end
-  end
-
-  class RequiredLibraryMissingError < StandardError
-    def initialize(message = nil)
-      message = message ? "#{message} is required! Please, install it." : "One of the required library is missing, e.g. git, curl, etc.!"
-      super(message)
-    end
-  end
-
+  # Error to be raised when Expectation is not same as Actual result
+  # used in Cucumber Tests
   class ExpectationNotMetError < StandardError
     def initialize(message = "Test failed because expectation was not met!")
       super(message)
     end
   end
 
-  class FileNotFoundError < StandardError
-    def initialize(message = nil)
-      message = message ? "File not found: #{message}" : "Could not find the specified file!"
-      super(message)
-    end
-  end
-
   # Show an error the user in Red, and exit the script, since this is an error!
   def self.handle_error(error, debug = false)
     shell = Thor::Shell::Color.new
@@ -59,7 +31,7 @@ module Laravel
       puts "--"
       puts error.backtrace
     end
-    exit
+    exit 128
   end
 
 end

data/lib/laravel/helpers.rb

@@ -7,9 +7,6 @@ module Laravel
     # the official Laravel repository URL which is also the default source for us.
     LaravelRepo = "http://github.com/laravel/laravel"
 
-    # the path to the setting.yml file for this gem
-    GemSettings = File.join(File.dirname(__FILE__), "settings.yml")
-
     # convert a string to MD5 hash - useful to generate quick random strings.
     #
     # ==== Parameters
@@ -20,12 +17,17 @@ module Laravel
     # +string+ :: a 32-character long MD5'ed string
     #
     def make_md5(string = nil)
+      # create a random string if one is not provided
       string ||= (0...32).map{ ('a'..'z').to_a[rand(26)] }.join
+      # hash it
       (Digest::MD5.new << string).to_s
     end
 
     # Check whether the given directory is the current directory.
     #
+    # ==== Parameters
+    # +dir+ :: the direcotry to check
+    #
     # ==== Return
     # +boolean+ :: True, if the app directory is the current directory.
     #
@@ -37,6 +39,9 @@ module Laravel
 
     # Check whether the given directory is empty?
     #
+    # ==== Parameters
+    # +dir+ :: the directory to check
+    #
     # ==== Return
     # +boolean+ :: True, if the app directory is an empty one.
     #
@@ -57,20 +62,28 @@ module Laravel
     #             and that the +source+ is an online file when +path+ is a file.
     # +source+ :: Source URL/directory from where the content of the resource will be
     #             downloaded. Please, read information about +path+
+    # +using+  :: can be either 'curl' or 'git' to download the resource
     #
     # ==== Return
     # +boolean+ :: true, if the resource was downloaded successfully.
     #
+    # ==== Raises
+    # +LaravelError+ :: if the required executable/binary is missing
+    #
     def download_resource(path, source, using)
-      raise RequiredLibraryMissingError, "curl" if using == "curl" and `which curl`.empty? and `which wget`.empty?
-      raise RequiredLibraryMissingError, "git" if using == "git"
+      using = "curl" if using == "shell"
+
+      # default to `wget` if `curl` is not found
+      using = "wget" if `which curl`.empty?
+      # raise an error if required library is not found
+      message = "#{using} is required! Please, install it!"
+      raise LaravelError, message if `which #{using}`.empty?
 
-      using = "wget" if using == "curl" and `which curl`.empty? and not `which wget`.empty?
+      # download the resource
       case using
-      when "git"  then system("git clone -q #{source} #{path}")
+      when "git"  then system("git clone -q #{source} #{path} &>/dev/null")
       when "curl" then system("curl -s #{source} > #{path}")
       when "wget" then system("wget #{source} -O #{path}")
-      else raise RequiredLibraryMissingError
       end
     end
 
@@ -94,24 +107,16 @@ module Laravel
       true
     end
 
-    # read the yaml configuration from a file
-    #
-    def read_yaml(file)
-      raise FileNotFoundError, file unless File.exists?(file)
-      data = YAML.load(File.open(file))
-      # adjust the 'config' hash by making substitutions
-      data["config"].each do |setting, matrix|
-        data["config"].delete(setting) if matrix.has_key?("supported") and not matrix["supported"]
-        data["config"][setting]["default"] = matrix["factory"] if matrix["default"] == "__factory__"
-      end
-      data
-    end
-
-    # write the configuration to a yaml file
+    # checks if a given variable is blank
+    #
+    # ==== Parameters
+    # +var+ :: the variable to check
+    #
+    # ==== Return
+    # +boolean+ :: true, if +var+ is +nil+, or if it is an empty +string+
     #
-    def write_yaml(data, file)
-      raise FileNotFoundError, file unless File.exists?(file)
-      File.open(file, "w") {|f| f.write(data.to_yaml) }
+    def is_blank?(var)
+      var.nil? or (var.is_a?(String) and var.strip.empty?)
     end
 
     # This method, simply, imitates the 'say' method that the Thor gem provides us.