ams_layout 0.0.2

data/lib/ams_layout/cli/config.rb

@@ -0,0 +1,250 @@
+##############################################################################
+# File::    config.rb
+# Purpose:: Config command
+# 
+# Author::    Jeff McAffee 2014-07-08
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+module AmsLayout
+
+  class Config < Thor
+
+    class Add < Thor
+
+      desc "env <envname> <url>", "add a environment url"
+      def env(envname, url)
+        with_loaded_config do
+          unless AmsLayout.configuration.base_urls.key? envname.to_sym
+            AmsLayout.configuration.base_urls[envname.to_sym] = url
+          else
+            say "environment '#{envname}' already exists", :red
+          end
+        end
+      end
+
+      desc "credentials <envname> <username> <pass>", "add login credentials for an environment"
+      def credentials(envname, username, pass)
+        with_loaded_config do
+          if AmsLayout.configuration.base_urls.key? envname.to_sym
+            unless AmsLayout.configuration.credentials.key? envname.to_sym
+              AmsLayout.configuration.credentials[envname.to_sym] = [username, pass]
+            else
+              say "credentials already exist for environment '#{envname}'"
+            end
+          else
+            say "environment '#{envname}' doesn't exist", :red
+            say "create environment before adding credentials", :red
+          end
+        end
+      end
+
+    private
+
+      def with_loaded_config &block
+        fail "expecting block" unless block_given?
+
+        unless AmsLayout.load_configuration
+          say "Configuration file not found!", :red
+          say "Have you tried 'config init' first?"
+          return
+        end
+
+        yield
+
+        AmsLayout.save_configuration
+      end
+    end
+
+    desc "add [CATEGORY]", "add a configuration value"
+    subcommand "add", Add
+
+
+    class Show < Thor
+
+      desc "envs", "display configured environments"
+      def envs
+        with_loaded_config do
+          say "Environments:"
+
+          output = []
+          AmsLayout.configuration.base_urls.each do |env, url|
+            output << [env, url]
+          end
+          print_table output, indent: 8
+        end
+      end
+
+      desc "credentials <envname>", "display configured credentials for an environment"
+      long_desc <<-LD
+        Display configured credentials for an environment.
+
+        If an environment name is not provided, credentials for all
+        environments will be displayed.
+      LD
+      def credentials(envname=nil)
+        with_loaded_config do
+          say "credentials:"
+
+          output = []
+          AmsLayout.configuration.credentials.each do |env, cred|
+            if envname.nil? || env == envname.to_sym
+              output << [env, cred.first, cred.last]
+            end
+          end
+          print_table output, indent: 8
+        end
+      end
+
+    private
+
+      def with_loaded_config &block
+        fail "expecting block" unless block_given?
+
+        unless AmsLayout.load_configuration
+          say "Configuration file not found!", :red
+          say "Have you tried 'config init' first?"
+          return
+        end
+
+        yield
+      end
+    end
+
+    desc "show [CATEGORY]", "display configuration values for [CATEGORY]"
+    subcommand "show", Show
+
+
+    class Del < Thor
+
+      desc "env <envname>", "delete an environment configuration"
+      def env(envname)
+        with_loaded_config do
+          if AmsLayout.configuration.base_urls.key?(envname.to_sym)
+            AmsLayout.configuration.base_urls.delete(envname.to_sym)
+          end
+        end
+
+        credentials(envname)
+      end
+
+      desc "credentials <envname>", "delete credentials for an environment"
+      def credentials(envname)
+        with_loaded_config do
+          if AmsLayout.configuration.credentials.key?(envname.to_sym)
+            AmsLayout.configuration.credentials.delete(envname.to_sym)
+          end
+        end
+      end
+
+    private
+
+      def with_loaded_config &block
+        fail "expecting block" unless block_given?
+
+        unless AmsLayout.load_configuration
+          say "Configuration file not found!", :red
+          say "Have you tried 'config init' first?"
+          return
+        end
+
+        yield
+
+        AmsLayout.save_configuration
+      end
+    end
+
+    desc "del [CATEGORY]", "delete a configuration value for [CATEGORY]"
+    subcommand "del", Del
+
+
+    desc "init <filedir>", "initialize a configuration file"
+    long_desc <<-LD
+      Create a configuration file.
+
+      If <filedir> is provided, config file will be written to the
+      given directory.
+
+      If <filedir> is not given, the configuration file will be
+      written to the current working directory.
+    LD
+    option :quiet, :type => :boolean, :default => false, :aliases => :q
+    def init(filedir = nil)
+      if filedir.nil?
+        filedir = Pathname.pwd + AmsLayout::CONFIG_FILE_NAME
+      else
+        filedir = Pathname(filedir) + AmsLayout::CONFIG_FILE_NAME unless filedir.to_s.end_with?("/#{AmsLayout::CONFIG_FILE_NAME}")
+      end
+
+      outpath = AmsLayout.save_configuration filedir
+      say("configuration written to #{outpath.to_s}", :green) unless options[:quiet]
+    end
+
+
+    desc "timeout <seconds>", "show or set the browser timeout period"
+    long_desc <<-LD
+      Show or set the browser timeout period.
+      Default value is 360.
+
+      If <seconds> is not provided, display the current setting.
+
+      <seconds> must be an integer value.
+    LD
+    def timeout(seconds=nil)
+      if seconds.nil?
+        with_loaded_config do
+          say "browser timeout: #{AmsLayout.configuration.browser_timeout}"
+        end
+      else
+        with_loaded_config(true) do
+          AmsLayout.configuration.browser_timeout = Integer(seconds)
+        end
+      end
+    rescue ArgumentError => e
+      say 'argument error: seconds must be an integer'
+    end
+
+
+    desc "defenv <envname>", "show or set the default environment"
+    long_desc <<-LD
+      Show or set the default environment.
+
+      If <envname> is not provided, display the current setting.
+
+      <envname> must be an existing environment.
+    LD
+    def defenv(envname=nil)
+      if envname.nil?
+        with_loaded_config do
+          say "default environment: #{AmsLayout.configuration.default_environment}"
+        end
+        return
+      end
+
+      with_loaded_config(true) do
+        if AmsLayout.configuration.base_urls.key? envname.to_sym
+          AmsLayout.configuration.default_environment = envname.to_sym
+        else
+          say "argument error: environment '#{envname}' has not been configured"
+        end
+      end
+    end
+
+  private
+
+    def with_loaded_config save = false
+      fail "expecting block" unless block_given?
+
+      unless AmsLayout.load_configuration
+        say "Configuration file not found!", :red
+        say "Have you tried 'config init' first?"
+        return
+      end
+
+      yield
+
+      AmsLayout.save_configuration if save
+    end
+  end # Config
+end # AmsLayout

data/lib/ams_layout/cli/generate.rb

@@ -0,0 +1,145 @@
+##############################################################################
+# File::    generate.rb
+# Purpose:: Generate command
+# 
+# Author::    Jeff McAffee 06/21/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'thor'
+require 'ams_layout/client'
+
+module AmsLayout
+  class Generate < Thor
+
+    desc "layout [PATH]", "write layout data to a file"
+    long_desc <<-LD
+      Generate layout data file.
+
+      File will be named layout.yml and placed in the directory (PATH)
+      you specify.
+
+      Directory must already exist or an error will be thrown.
+    LD
+    option :env, :banner => "dev", :aliases => :e
+    def layout(path)
+      env = AmsLayout.configuration.default_environment
+      env = options[:env] if options[:env]
+      user, pass = credentials env
+
+      client.login(user, pass)
+      client.write_layout path, false
+      client.logout
+    end
+
+    desc "cls <opts> [PATH] [LAYOUT_PATH]", "write layout class to a file"
+    long_desc <<-LD
+      Generate layout class.
+
+      Options:
+
+        -n ClassName specify name of layout class (default: LoanEntryFields)
+
+      Arguments:
+
+      [PATH] Path to directory where layout class will be created.
+
+      [LAYOUT_PATH] Path to directory containing layout data (layout.yml)
+
+      Directories must already exist or an error will be thrown.
+    LD
+    option :name, :banner => "ClassName", :aliases => :n
+    def cls(path, layout_path)
+      if options[:name]
+        client.layout_class_name = options[:name]
+      end
+
+      client.write_layout_class path, layout_path
+    end
+
+    desc "delegate <opts> [PATH] [LAYOUT_PATH]", "write delegate class to a file"
+    long_desc <<-LD
+      Generate delegate class.
+
+      Options:
+
+        -d ClassName specify name of delegate class (default: DelegateLoanEntryFields)
+
+      Arguments:
+
+      [PATH] Path to directory where delegate class will be created.
+
+      [LAYOUT_PATH] Path to directory containing layout data (layout.yml)
+
+      Directories must already exist or an error will be thrown.
+    LD
+    option :delegate, :banner => "DelegateClassName", :aliases => :d
+    def delegate(path, layout_path)
+      if options[:delegate]
+        client.delegate_class_name = options[:delegate]
+      end
+
+      client.write_delegate_class path, layout_path
+    end
+
+    desc "all <opts> [PATH]", "write layout data, layout class, and delegate class files to a path"
+    long_desc <<-LD
+      Generate layout data file (layout.yml), layout class, and delegate layout class.
+
+      Options:
+
+        -n ClassName specify name of layout class (default: LoanEntryFields)
+
+        -d ClassName specify name of delegate class (default: DelegateLoanEntryFields)
+
+      Arguments:
+
+      [PATH] Path to directory where files will be created.
+
+      Directory must already exist or an error will be thrown.
+    LD
+    option :name, :banner => "ClassName", :aliases => :n
+    option :delegate, :banner => "DelegateClassName", :aliases => :d
+    option :env, :banner => "dev", :aliases => :e
+    def all(path)
+      env = AmsLayout.configuration.default_environment
+      env = options[:env] if options[:env]
+      user, pass = credentials env
+
+      # Generate layout file
+      client.login(user, pass)
+      client.write_layout path, false
+      client.logout
+
+      # Generate layout class
+      if options[:name]
+        client.layout_class_name = options[:name]
+      end
+
+      client.write_layout_class path, path
+
+      # Generate delegate class
+      if options[:delegate]
+        client.delegate_class_name = options[:delegate]
+      end
+
+      client.write_delegate_class path, path
+    end
+
+  private
+
+    def client
+      AmsLayout.client
+    end
+
+    def credentials env
+      user, pass = AmsLayout.configuration.credentials[env]
+      if user.nil? || pass.nil?
+        user = ask "username for #{env} environment:"
+        pass = ask "password:"
+      end
+      [user, pass]
+    end
+  end
+end # AmsLayout

data/lib/ams_layout/cli.rb

@@ -0,0 +1,29 @@
+##############################################################################
+# File::    cli.rb
+# Purpose:: Command Line Interface
+# 
+# Author::    Jeff McAffee 06/21/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'thor'
+require 'ams_layout/cli/config'
+require 'ams_layout/cli/generate'
+
+module AmsLayout
+  class CLI < Thor
+
+    def self.start(*)
+      super
+    rescue Exception => e
+      raise e
+    end
+
+    desc "config [COMMAND]", "modify configuration file"
+    subcommand "config", AmsLayout::Config
+
+    desc "generate [COMMAND]", "generate one or more files"
+    subcommand "generate", AmsLayout::Generate
+  end # CLI
+end # AmsLayout

data/lib/ams_layout/client.rb

@@ -0,0 +1,190 @@
+##############################################################################
+# File::    client.rb
+# Purpose:: AmsLayout Client object
+# 
+# Author::    Jeff McAffee 06/21/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ams_layout/pages'
+require 'ams_layout/core_ext'
+
+module AmsLayout
+  class Client
+    include AmsLayout::Pages
+
+    attr_writer :layout_class_name
+    attr_writer :delegate_class_name
+
+    def initialize
+      # Make sure the configuration has been initialized.
+      AmsLayout.configure
+    end
+
+    def layout_class_name
+      @layout_class_name ||= AmsLayout.configuration.layout_class_name
+    end
+
+    def delegate_class_name
+      @delegate_class_name ||= AmsLayout.configuration.delegate_class_name
+    end
+
+    ##
+    # Set the current environment
+
+    def environment=(env)
+      raise "Unknown environment [#{env}]" unless AmsLayout.configuration.credentials.key?(env)
+      @env = env
+      AmsLayout.configure do |config|
+        config.default_environment = env
+      end
+    end
+
+    ##
+    # Return the current environment
+
+    def environment
+      @env ||= AmsLayout.configuration.default_environment
+      @env
+    end
+
+    ##
+    # Return the credentials for the current environment
+
+    def credentials
+      return AmsLayout.configuration.credentials[environment]
+    end
+
+    ##
+    # Return the base url for the current environment
+
+    def base_url
+      return AmsLayout.configuration.base_urls[environment]
+    end
+
+    ##
+    # Login to the Admin Module
+    #
+    # If we're already logged in, do nothing unless the +force+ flag is true.
+    #
+    # +force+ force a re-login if we've already logged in
+
+    def login(username, password, options = {})
+      force = options.fetch(:force) { false }
+
+      logout
+      login_page(force).login_as username, password
+    end
+
+    def logout
+      login_page.logout
+      @login_page = nil
+    end
+
+    ##
+    # Close the browser
+
+    def quit
+      unless @browser.nil?
+        logout
+        @browser.close
+        @browser = nil
+      end
+    end
+
+    ##
+    # Retrieve field data from Loan Entry (Prequal) screen
+
+    def get_field_data
+      prequal = PrequalDetail.new(browser, true)
+      parser = Parser.new
+      parser.parse prequal.html
+      parser.layout
+    end
+
+    def write_layout path, write_alias_example = false
+      layout = get_field_data
+      File.write layout_path(path), YAML.dump(layout)
+
+      write_alias_example layout_path(path) if write_alias_example
+    end
+
+    def write_alias_example layout_file_path
+      layout = YAML::load_file(layout_path(layout_file_path))
+      aliases = {}
+
+      layout.each do |section_label, fields|
+        fields.each do |fld|
+          label = fld[:label]
+          aliases[label] = [
+            "Alias1 #{label}",
+            "Alias2 #{label}"
+          ]
+        end # fields
+      end # layout
+
+      File.write "#{layout_path(layout_file_path)}.aliases.example", YAML.dump(aliases)
+    end
+
+    def write_layout_class path, layout_file_path
+      assert_file_exists layout_path(layout_file_path)
+
+      layout = YAML::load_file(layout_path(layout_file_path))
+      aliases = YAML::load_file("#{layout_path(layout_file_path)}.aliases") if File.exist?("#{layout_path(layout_file_path)}.aliases")
+      writer = Writer.new
+      writer.class_name = layout_class_name
+      writer.aliases = aliases unless aliases.nil?
+
+      File.open(layout_class_path(path), 'w') do |f|
+        writer.write f, layout
+      end
+    end
+
+    def write_delegate_class path, layout_file_path
+      assert_file_exists layout_path(layout_file_path)
+
+      layout = YAML::load_file(layout_path(layout_file_path))
+      aliases = YAML::load_file("#{layout_path(layout_file_path)}.aliases") if File.exist?("#{layout_path(layout_file_path)}.aliases")
+      writer = DelegateWriter.new
+      writer.class_name = delegate_class_name
+      writer.aliases = aliases unless aliases.nil?
+
+      File.open(delegate_class_path(path), 'w') do |f|
+        writer.write f, layout
+      end
+    end
+
+  private
+
+    def layout_path path
+      path = Pathname(path)
+      filename = 'layout.yml'
+      path = path + filename
+    end
+
+    def layout_class_path path
+      path = Pathname(path)
+      filename = layout_class_name.ams_layout_snakecase + '.rb'
+      path = path + filename
+    end
+
+    def delegate_class_path path
+      path = Pathname(path)
+      filename = delegate_class_name.ams_layout_snakecase + '.rb'
+      path = path + filename
+    end
+
+    def login_page force = false
+      if force || @login_page.nil?
+        @login_page = LoginPage.new(browser, true)
+      end
+
+      @login_page
+    end
+
+    def assert_file_exists filename
+      fail "#{filename} does not exist" unless File.exist?(filename)
+    end
+  end # Client
+end # AmsLayout

data/lib/ams_layout/core_ext/string.rb

@@ -0,0 +1,30 @@
+##############################################################################
+# File::    string.rb
+# Purpose:: String monkey patches
+# 
+# Author::    Jeff McAffee 07/08/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+
+# Re-open String class and add snakecase method.
+class String
+  def ams_layout_snakecase
+    # Strip everything but alphanumerics, :, _, - and space
+    # Replace :: with /
+    # Separate CamelCased text with _
+    # Remove :
+    # Replace space and - with _
+    # Replace multiple _ with one _
+    self.gsub(/[^a-zA-Z0-9:_\s-]/, '').
+    gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    gsub(/:/, '').
+    gsub(/[\s-]/, '_').
+    gsub(/(_)+/,'_').
+    downcase
+  end
+end
+

data/lib/ams_layout/core_ext.rb

@@ -0,0 +1,11 @@
+##############################################################################
+# File::    core_ext.rb
+# Purpose:: Core object extensions (monkey patches)
+# 
+# Author::    Jeff McAffee 07/08/2014
+# Copyright:: Copyright (c) 2014, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ams_layout/core_ext/string'
+