tennpipes-init 3.6.6

data/lib/tennpipes-init/generators/app.rb

@@ -0,0 +1,75 @@
+module Tennpipes
+  module Generators
+
+    ##
+    # Responsible for applications within a Tennpipes project. Creates and mounts
+    # the application and gives the user related information.
+    #
+    class App < Thor::Group
+
+      Tennpipes::Generators.add_generator(:app, self)
+
+      def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      def self.banner; "tennpipes-init app [name]"; end
+
+      include Thor::Actions
+      include Tennpipes::Generators::Actions
+
+      desc "Description:\n\n\ttennpipes-init app generates a new Tennpipes application"
+      argument     :name,      :desc => 'The name of your tennpipes application'
+      class_option :root,      :desc => 'The root destination',                     :aliases => '-r', :default => '.',   :type => :string
+      class_option :destroy,                                                        :aliases => '-d', :default => false, :type => :boolean
+      class_option :tiny,      :desc => 'Generate tiny app skeleton',               :aliases => '-i', :default => false, :type => :boolean
+      class_option :namespace, :desc => 'The name space of your tennpipes project',   :aliases => '-n', :default => '',    :type => :string
+      class_option :force,     :desc => 'Generate app files if app already exists', :aliases => '-f', :default => false, :type => :boolean
+
+      # Show help if no ARGV given
+      require_arguments!
+
+      ##
+      # Copies over the Tennpipes base admin application.
+      #
+      def create_app
+        self.destination_root = options[:root]
+        underscore_name = name.gsub(/\W/, '_')
+        @app_folder = underscore_name.underscore
+        @app_name   = underscore_name.camelize
+        if in_app_root?
+          @project_name = options[:namespace].underscore.camelize
+          @project_name = fetch_project_name(@app_folder) if @project_name.empty?
+
+          if options[:destroy]
+            self.behavior = :revoke
+          else
+            unless options[:force]
+              say "#{@app_name} already exists."
+              say "Please, change the name."
+              return
+            end
+          end if already_exists?(@app_name, @project_name)
+
+          lowercase_app_folder = @app_folder.downcase
+          app_skeleton(lowercase_app_folder, options[:tiny])
+          empty_directory destination_root("public/#{lowercase_app_folder}")
+
+          mount_command = "\nTennpipes.mount('#{@project_name}::#{@app_name}', :app_file => Tennpipes.root('#{lowercase_app_folder}/app.rb')).to('/#{lowercase_app_folder}')\n"
+          if File.read(destination_root('config/apps.rb')).match(/^Tennpipes.mount.*\.to\('\/'\)$/)
+            inject_into_file destination_root('config/apps.rb'), mount_command, :before => /^Tennpipes.mount.*\.to\('\/'\)$/
+          else
+            append_file destination_root('config/apps.rb'), mount_command
+          end
+
+          return if self.behavior == :revoke
+          say
+          say '=' * 65, :green
+          say "Your #{@app_name} application has been installed."
+          say '=' * 65, :green
+          say "This application has been mounted to /#{@app_name.downcase}"
+          say "You can configure a different path by editing 'config/apps.rb'"
+        else
+          say 'You are not at the root of a Tennpipes application! (config/boot.rb not found)'
+        end
+      end
+    end
+  end
+end

data/lib/tennpipes-init/generators/app/app.rb.tt

@@ -0,0 +1,72 @@
+module <%= @project_name %>
+  class <%= @app_name %> < Tennpipes::Application
+    register Tennpipes::Mailer
+    register Tennpipes::Helpers
+
+    enable :sessions
+
+    class <%= @project_name %>::<%= @app_name %>
+      get '/' do
+        erb :home
+      end
+    end
+
+
+    ##
+    # Caching support.
+    #
+    # register Tennpipes::Cache
+    # enable :caching
+    #
+    # You can customize caching store engines:
+    #
+    # set :cache, Tennpipes::Cache.new(:LRUHash) # Keeps cached values in memory
+    # set :cache, Tennpipes::Cache.new(:Memcached) # Uses default server at localhost
+    # set :cache, Tennpipes::Cache.new(:Memcached, '127.0.0.1:11211', :exception_retry_limit => 1)
+    # set :cache, Tennpipes::Cache.new(:Memcached, :backend => memcached_or_dalli_instance)
+    # set :cache, Tennpipes::Cache.new(:Redis) # Uses default server at localhost
+    # set :cache, Tennpipes::Cache.new(:Redis, :host => '127.0.0.1', :port => 6379, :db => 0)
+    # set :cache, Tennpipes::Cache.new(:Redis, :backend => redis_instance)
+    # set :cache, Tennpipes::Cache.new(:Mongo) # Uses default server at localhost
+    # set :cache, Tennpipes::Cache.new(:Mongo, :backend => mongo_client_instance)
+    # set :cache, Tennpipes::Cache.new(:File, :dir => Tennpipes.root('tmp', app_name.to_s, 'cache')) # default choice
+    #
+
+    ##
+    # Application configuration options.
+    #
+    # set :raise_errors, true       # Raise exceptions (will stop application) (default for test)
+    # set :dump_errors, true        # Exception backtraces are written to STDERR (default for production/development)
+    # set :show_exceptions, true    # Shows a stack trace in browser (default for development)
+    # set :logging, true            # Logging in STDOUT for development and file for production (default only for development)
+    # set :public_folder, 'foo/bar' # Location for static assets (default root/public)
+    # set :reload, false            # Reload application files (default in development)
+    # set :default_builder, 'foo'   # Set a custom form builder (default 'StandardFormBuilder')
+    # set :locale_path, 'bar'       # Set path for I18n translations (default your_apps_root_path/locale)
+    # disable :sessions             # Disabled sessions by default (enable if needed)
+    # disable :flash                # Disables sinatra-flash (enabled by default if Sinatra::Flash is defined)
+    # layout  :my_layout            # Layout can be in views/layouts/foo.ext or views/foo.ext (default :application)
+    #
+
+    ##
+    # You can configure for a specified environment like:
+    #
+    #   configure :development do
+    #     set :foo, :bar
+    #     disable :asset_stamp # no asset timestamping for dev
+    #   end
+    #
+
+    ##
+    # You can manage errors like:
+    #
+    #   error 404 do
+    #     render 'errors/404'
+    #   end
+    #
+    #   error 500 do
+    #     render 'errors/500'
+    #   end
+    #
+  end
+end

data/lib/tennpipes-init/generators/app/app.rb.tt~

@@ -0,0 +1,72 @@
+module <%= @project_name %>
+  class <%= @app_name %> < Tennpipes::Application
+    register Tennpipes::Mailer
+    register Tennpipes::Helpers
+
+    enable :sessions
+
+    class <%= @project_name %>::<%= @app_name %>
+      get '/' do
+        erb :<%= @app_name.downcase %>
+      end
+    end
+
+
+    ##
+    # Caching support.
+    #
+    # register Tennpipes::Cache
+    # enable :caching
+    #
+    # You can customize caching store engines:
+    #
+    # set :cache, Tennpipes::Cache.new(:LRUHash) # Keeps cached values in memory
+    # set :cache, Tennpipes::Cache.new(:Memcached) # Uses default server at localhost
+    # set :cache, Tennpipes::Cache.new(:Memcached, '127.0.0.1:11211', :exception_retry_limit => 1)
+    # set :cache, Tennpipes::Cache.new(:Memcached, :backend => memcached_or_dalli_instance)
+    # set :cache, Tennpipes::Cache.new(:Redis) # Uses default server at localhost
+    # set :cache, Tennpipes::Cache.new(:Redis, :host => '127.0.0.1', :port => 6379, :db => 0)
+    # set :cache, Tennpipes::Cache.new(:Redis, :backend => redis_instance)
+    # set :cache, Tennpipes::Cache.new(:Mongo) # Uses default server at localhost
+    # set :cache, Tennpipes::Cache.new(:Mongo, :backend => mongo_client_instance)
+    # set :cache, Tennpipes::Cache.new(:File, :dir => Tennpipes.root('tmp', app_name.to_s, 'cache')) # default choice
+    #
+
+    ##
+    # Application configuration options.
+    #
+    # set :raise_errors, true       # Raise exceptions (will stop application) (default for test)
+    # set :dump_errors, true        # Exception backtraces are written to STDERR (default for production/development)
+    # set :show_exceptions, true    # Shows a stack trace in browser (default for development)
+    # set :logging, true            # Logging in STDOUT for development and file for production (default only for development)
+    # set :public_folder, 'foo/bar' # Location for static assets (default root/public)
+    # set :reload, false            # Reload application files (default in development)
+    # set :default_builder, 'foo'   # Set a custom form builder (default 'StandardFormBuilder')
+    # set :locale_path, 'bar'       # Set path for I18n translations (default your_apps_root_path/locale)
+    # disable :sessions             # Disabled sessions by default (enable if needed)
+    # disable :flash                # Disables sinatra-flash (enabled by default if Sinatra::Flash is defined)
+    # layout  :my_layout            # Layout can be in views/layouts/foo.ext or views/foo.ext (default :application)
+    #
+
+    ##
+    # You can configure for a specified environment like:
+    #
+    #   configure :development do
+    #     set :foo, :bar
+    #     disable :asset_stamp # no asset timestamping for dev
+    #   end
+    #
+
+    ##
+    # You can manage errors like:
+    #
+    #   error 404 do
+    #     render 'errors/404'
+    #   end
+    #
+    #   error 500 do
+    #     render 'errors/500'
+    #   end
+    #
+  end
+end

data/lib/tennpipes-init/generators/cli.rb

@@ -0,0 +1,57 @@
+require 'thor/group'
+
+module Tennpipes
+  module Generators
+    ##
+    # This class bootstrap +config/boot+ and perform
+    # +Tennpipes::Generators.load_components!+ for handle 3rd party generators.
+    #
+    class Cli < Thor::Group
+
+      include Thor::Actions
+
+      class_option :root, :desc => "The root destination", :aliases => '-r', :default => ".", :type => :string
+      class_option :help, :type => :boolean, :desc => "Show help usage"
+
+      ##
+      # We need to try to load boot because some of our app dependencies maybe have
+      # custom generators, so is necessary know who are.
+      #
+      def load_boot
+        begin
+          ENV['TENNPIPES_LOG_LEVEL'] ||= 'test'
+          ENV['BUNDLE_GEMFILE'] = File.join(options[:root], 'Gemfile') if options[:root]
+          boot = options[:root] ? File.join(options[:root], 'config/boot.rb') : 'config/boot.rb'
+          if File.exist?(boot)
+            require File.expand_path(boot)
+          else
+            require 'tennpipes-assist'
+          end
+        rescue StandardError => e
+          puts "=> Problem loading #{boot}"
+          puts ["=> #{e.message}", *e.backtrace].join("\n  ")
+        ensure
+          ENV.delete('BUNDLE_GEMFILE')
+          ENV.delete('TENNPIPES_LOG_LEVEL')
+        end
+      end
+
+      ##
+      # Loads the components available for all generators.
+      #
+      def setup
+        Tennpipes::Generators.load_components!
+
+        generator_kind  = ARGV.delete_at(0).to_s.downcase.to_sym if ARGV[0].present?
+        generator_class = Tennpipes::Generators.mappings[generator_kind]
+
+        if generator_class
+          args = ARGV.empty? && generator_class.require_arguments? ? ['-h'] : ARGV
+          generator_class.start(args)
+        else
+          puts "Please specify generator to use (#{Tennpipes::Generators.mappings.keys.join(", ")})"
+        end
+      end
+    end
+  end
+end

data/lib/tennpipes-init/generators/component.rb

@@ -0,0 +1,73 @@
+module Tennpipes
+  module Generators
+
+    ##
+    # Responsible for add components within a Tennpipes project.
+    #
+    class Component < Thor::Group
+
+      Tennpipes::Generators.add_generator(:component, self)
+
+      def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      def self.banner; "tennpipes-init component [options]"; end
+
+      include Thor::Actions
+      include Tennpipes::Generators::Actions
+      include Tennpipes::Generators::Components::Actions
+
+      desc "Description:\n\n\ttennpipes-init component add components into a Tennpipes project"
+
+      class_option :app,     :desc => 'The application name',                                             :aliases => '-n', :default => nil,         :type => :string
+      class_option :root,    :desc => 'The root destination',                                             :aliases => '-r', :default => '.',         :type => :string
+      class_option :adapter, :desc => 'SQL adapter for ORM (sqlite, mysql, mysql2, mysql-gem, postgres)', :aliases => '-a', :default => 'sqlite',    :type => :string
+
+      defines_component_options :default => false
+
+      ##
+      # For each component, retrieve a valid choice and then execute the associated generator.
+      #
+      def setup_components
+        self.destination_root = options[:root]
+        if in_app_root?
+          @_components = options.dup.slice(*self.class.component_types)
+          @app_name = (options[:app] || "App").gsub(/\W/, '_').camelize
+          if @_components.values.delete_if(&:blank?).empty?
+            self.class.start(["-h"])
+            say
+            say "Current Selected Components:"
+            list = []
+            self.class.component_types.each do |comp|
+              list << [comp, fetch_component_choice(comp)]
+            end
+            print_table(list, :indent => 2)
+            exit
+          end
+
+          self.class.component_types.each do |comp|
+            next if @_components[comp].blank?
+
+            choice = @_components[comp] = resolve_valid_choice(comp)
+            existing = fetch_component_choice(comp)
+            if existing != 'none' && existing != choice
+              next unless yes?("Switch #{comp} to '#{choice}' from '#{existing}' ?[yes/no]:")
+            end
+            @project_name = fetch_component_choice(:namespace)
+            if comp.to_s == 'test' && !already_exists?(@app_name, @project_name)
+              say "#{@project_name}::#{@app_name} does not exist."
+              say "Please, change app name."
+              next
+            end
+            execute_component_setup(comp, choice)
+            store_component_choice(comp, choice)
+            if comp.to_s == 'orm' && choice.to_s != 'none'
+              inject_into_file destination_root('Rakefile'), "TennpipesTasks.use(:database)\n", :before => "TennpipesTasks.init"
+              inject_into_file destination_root('Rakefile'), "TennpipesTasks.use(#{choice.to_sym.inspect})\n", :before => "TennpipesTasks.init"
+            end
+          end
+        else
+          say 'You are not at the root of a Tennpipes application! (config/boot.rb not found)'
+        end
+      end
+    end
+  end
+end

data/lib/tennpipes-init/generators/components/actions.rb

@@ -0,0 +1,208 @@
+module Tennpipes
+  module Generators
+    module Components
+      module Actions
+        ##
+        # Generates the model migration file created when generating a new model.
+        #
+        # @param [String] filename
+        #   File name of model migration.
+        # @param [String] name
+        #   Name of model.
+        # @param [Array<String>] columns
+        #   Array of column names and property type.
+        # @param [Hash] options
+        #   Additional migration options, e.g
+        #   { :base => "....text...", :up => "..text...",
+        #     :down => "..text...", column_format => "t.column :#{field}, :#{kind}" }
+        # @example
+        #   output_model_migration("AddPerson", "person", ["name:string", "age:integer"],
+        #     :base => AR_MIGRATION,
+        #     :column_format => Proc.new { |field, kind| "t.#{kind.underscore.gsub(/_/, '')} :#{field}" },
+        #     :up => AR_MODEL_UP_MG, :down => AR_MODEL_DOWN_MG)
+        #
+        def output_model_migration(filename, name, columns, options={})
+          if behavior == :revoke
+            remove_migration(filename)
+          else
+            return if migration_exist?(filename)
+            model_name = name.to_s.pluralize
+            field_tuples = columns.map { |value| value.split(":") }
+            field_tuples.map! { |field, kind| kind =~ /datetime/i ? [field, 'DateTime'] : [field, kind] }
+            column_declarations = field_tuples.map(&options[:column_format]).join("\n      ")
+            contents = options[:base].dup.gsub(/\s{4}!UP!\n/m, options[:up]).gsub(/!DOWN!\n/m, options[:down])
+            contents = contents.gsub(/!NAME!/, model_name.underscore.camelize).gsub(/!TABLE!/, model_name.underscore)
+            contents = contents.gsub(/!FILENAME!/, filename.underscore).gsub(/!FILECLASS!/, filename.underscore.camelize)
+            migration_number = current_migration_number
+            contents = contents.gsub(/!FIELDS!/, column_declarations).gsub(/!VERSION!/, migration_number)
+            migration_filename = "#{format("%03d", migration_number)}_#{filename.underscore}.rb"
+            create_file(destination_root('db/migrate/', migration_filename), contents, :skip => true)
+          end
+        end
+
+        ##
+        # Generates a standalone migration file based on the given options and columns.
+        #
+        # @param [String] filename
+        #   File name of model migration.
+        # @param [String] name
+        #   Name of model.
+        # @param [Array<String>] columns
+        #   Array of column names and property type.
+        # @param [Hash] options
+        #   Additional migration options, e.g
+        #     { :base "...text...", :change_format => "...text...",
+        #       :add => proc { |field, kind| "add_column :#{table_name}, :#{field}, :#{kind}" },
+        #       :remove => proc { |field, kind| "remove_column :#{table_name}, :#{field}" }
+        # @example
+        #   output_migration_file(migration_name, name, columns,
+        #     :base => AR_MIGRATION, :change_format => AR_CHANGE_MG,
+        #     :add => Proc.new { |field, kind| "t.#{kind.underscore.gsub(/_/, '')} :#{field}" },
+        #     :remove => Proc.new { |field, kind| "t.remove :#{field}" }
+        #   )
+        #
+        def output_migration_file(filename, name, columns, options={})
+          if behavior == :revoke
+            remove_migration(name)
+          else
+            return if migration_exist?(filename)
+            change_format = options[:change_format]
+            migration_scan = filename.underscore.camelize.scan(/(Add|Remove).*?(?:(?:To|From).+?)*(?:To|From)((?:To|From)?.*?)$/).flatten
+            direction, table_name = migration_scan[0].downcase, migration_scan[1].downcase.pluralize if migration_scan.any?
+            tuples = direction ? columns.map { |value| value.split(":") } : []
+            tuples.map! { |field, kind| kind =~ /datetime/i ? [field, 'DateTime'] : [field, kind] }
+            add_columns    = tuples.map(&options[:add]).join("\n    ")
+            remove_columns = tuples.map(&options[:remove]).join("\n    ")
+            forward_text = change_format.gsub(/!TABLE!/, table_name).gsub(/!COLUMNS!/, add_columns) if tuples.any?
+            back_text    = change_format.gsub(/!TABLE!/, table_name).gsub(/!COLUMNS!/, remove_columns) if tuples.any?
+            contents = options[:base].dup.gsub(/\s{4}!UP!\n/m,   (direction == 'add' ? forward_text.to_s : back_text.to_s))
+            contents.gsub!(/\s{4}!DOWN!\n/m, (direction == 'add' ? back_text.to_s : forward_text.to_s))
+            contents = contents.gsub(/!FILENAME!/, filename.underscore).gsub(/!FILECLASS!/, filename.underscore.camelize)
+            migration_number = current_migration_number
+            contents.gsub!(/!VERSION!/, migration_number)
+            migration_filename = "#{format("%03d", migration_number)}_#{filename.underscore}.rb"
+            create_file(destination_root('db/migrate/', migration_filename), contents, :skip => true)
+          end
+        end
+
+        ##
+        # Returns the number of the latest(most current) migration file.
+        #
+        def return_last_migration_number
+          Dir[destination_root('db/migrate/*.rb')].map { |f|
+            File.basename(f).match(/^(\d+)/)[0].to_i
+          }.max.to_i || 0
+        end
+
+        ##
+        # Returns timestamp instead if :migration_format: in .components is "timestamp"
+        #
+        def current_migration_number
+          if fetch_component_choice(:migration_format).to_s == 'timestamp'
+            Time.now.utc.strftime("%Y%m%d%H%M%S")
+          else
+            return_last_migration_number + 1
+          end.to_s
+        end
+
+        ##
+        # Return true if the migration already exist.
+        #
+        # @param [String] filename
+        #   File name of the migration file.
+        #
+        def migration_exist?(filename)
+          Dir[destination_root("db/migrate/*_#{filename.underscore}.rb")].size > 0
+        end
+
+        ##
+        # Removes the migration file based on the migration name.
+        #
+        # @param [String] name
+        #   File name of the migration.
+        #
+        def remove_migration(name)
+          migration_path =  Dir[destination_root('db/migrate/*.rb')].find do |f|
+            File.basename(f) =~ /#{name.to_s.underscore}/
+          end
+          return unless migration_path
+          if behavior == :revoke
+            create_file migration_path # we use create to reverse the operation of a revoke
+          end
+        end
+
+        ##
+        # Injects the test class text into the test_config file for setting up the test gen.
+        #
+        # @param [String] suite_text
+        #   Class name for test suite.
+        # @param [Hash] options
+        #   Additional options to pass into injection.
+        #
+        # @example
+        #   insert_test_suite_setup('...CLASS_NAME...')
+        #   => inject_into_file("test/test_config.rb", TEST.gsub(/CLASS_NAME/, @app_name), :after => "set :environment, :test")
+        #
+        def insert_test_suite_setup(suite_text, options={})
+          options.reverse_merge!(:path => "test/test_config.rb")
+          create_file(options[:path], suite_text.gsub(/CLASS_NAME/, "#{@project_name}::#{@app_name}"))
+        end
+
+        ##
+        # Injects the mock library include into the test class in test_config
+        # for setting up mock gen
+        #
+        # @param [String] library_name
+        #   Name of mocking library.
+        # @param [Hash] options
+        #
+        # @example
+        #   insert_mocking_include('Mocha::API'):
+        #   => inject_into_file("test/test_config.rb", "  include Mocha::API\n", :after => /class.*?\n/)
+        #
+        def insert_mocking_include(library_name, options={})
+          options.reverse_merge!(:indent => 2, :after => /class.*?\n/, :path => "test/test_config.rb")
+          return unless File.exist?(destination_root(options[:path]))
+          include_text = indent_spaces(2) + "include #{library_name}\n"
+          inject_into_file(options[:path], include_text, :after => options[:after])
+        end
+
+        ##
+        # Returns space characters of given count.
+        #
+        # @example
+        #   indent_spaces(2)
+        #
+        def indent_spaces(count)
+          ' ' * count
+        end
+
+        ##
+        # Takes in fields for routes in the form of get:index post:test delete:yada.
+        #
+        # @param [Array<String>] fields
+        #   Array of controller actions and route name.
+        #
+        # @example
+        #   controller_actions("get:index", "post:test")
+        #
+        def controller_actions(fields)
+          field_tuples = fields.map { |value| value.split(":") }
+          action_declarations = field_tuples.map do |request, name|
+            "#{request} :#{name} do\n\nend\n"
+          end
+          action_declarations.join("\n").gsub(/^/, " " * 2).gsub(/^\s*$/, "")
+        end
+
+        def create_helper_files(app, name)
+          @helper_name  = "#{name.to_s.underscore.camelize}Helper"
+          template 'templates/helper.rb.tt', destination_root(app, 'helpers', "#{name.to_s.underscore}_helper.rb")
+          if test?
+            include_component_module_for(:test)
+            generate_helper_test(@helper_name, @project_name, @app_name)
+          end
+        end
+      end
+    end
+  end
+end