solr_makr 0.0.4 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ab4901f4917ead570f380ab68ebcb7b7cdafa1b
-  data.tar.gz: 67e750b0a1e551c90a1c062609499cd6d28812a2
+  metadata.gz: 2e4ea507a10b5bcd9b05ae529856fa3394456a34
+  data.tar.gz: 8a268eb91d40dba267e11f9bfdf1d8de8b05141c
 SHA512:
-  metadata.gz: 8b704d4a52229f75c8c62210e481dba089b41a5ef5c352098884195376f99357059bbaa7cd910177ad69382eb5d6f2a6c913ce757f893056eb72429de476014a
-  data.tar.gz: e0c13ff707f74bf9d5a436139c08035b389d938e19168ddc85344944dcb308bda93002c9ba91a2b81f5b4ed3a5db43b15407c601565926868daf2d06af88050d
+  metadata.gz: 0b29e04ce7b2fda319d937ed0747ba8d26dfa2b851377b9a5f2703f1b429b66eb45735a3f7e31f9406cd69469e621ba4cf6b0d75a8f04dfc07638d1b7f72668c
+  data.tar.gz: 185b6005cda2283402fe4026be8999e1269dcccaa2470d7002a85e1f0ccc0a859ee75ef5e541bb12487a4d1938ccee28f141b6d8beb906343417be25127b3438

data/.agignore

@@ -0,0 +1 @@
+solr

data/README.md

@@ -2,17 +2,39 @@
 
 Create and destroy solr cores programmatically.
 
+Assumes Solr 5.x with zookeeper running on the default ports.
+
+See `solr-makr --help` to customize port information.
+
 ## Installation
 
     $ gem install solr_makr
 
 ## Usage
 
-TODO: Write usage instructions here
+To set up:
+
+```sh
+# only need to run once, to set up local configuration directory
+
+solr-makr setup
+```
+
+To create a core:
+
+```sh
+solr-makr create --name foo
+```
+
+To generate a valid yaml configuration for use with sunspot:
+
+```sh
+solr-makr yaml --name foo -o sunspot.yml
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/scryptmouse/apple_solr/fork )
+1. Fork it ( https://github.com/scryptmouse/solr_makr/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,2 +1,2 @@
 require "bundler/gem_tasks"
-
+require "sunspot/solr/tasks"

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "solr_makr"
+
+require "pry"
+
+SOLR      = SolrMakr::SolrAPI::Client.new
+#SUNSPOT   = Pathname.new('/Users/mouse/projects/hral/hrsc-sunspot')
+
+include SolrMakr
+
+Pry.start

data/exe/solr-makr

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "solr_makr"
+
+$app = SolrMakr::Application.new
+
+$app.run
+
+exit $app.exit_status

data/lib/solr_makr.rb

@@ -1,44 +1,97 @@
 require "fileutils"
+require "find"
 require "pathname"
+require "set"
 require "yaml"
 
-class Pathname
-  alias_method :to_str, :to_s
-end
-
+require "active_support/callbacks"
 require "active_support/concern"
 require "active_support/configurable"
+require 'active_support/core_ext/hash/indifferent_access'
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/object/try"
+require "active_support/core_ext/object/with_options"
 require "active_support/core_ext/module/delegation"
+require "active_support/dependencies/autoload"
+require "active_interaction"
 require "attr_lazy"
 require "commander"
-require "nokogiri"
-require "typhoeus"
+require "httparty"
+require "lmdb"
+require "rugged"
+require "toml"
+require "terminal-table"
 require "virtus"
+require "zk"
 
 require "solr_makr/version"
-require "solr_makr/solr_request"
-require "solr_makr/core_status"
-require "solr_makr/solr_configuration"
-require "solr_makr/core"
-require "solr_makr/commands"
-require "solr_makr/commands/shared"
-require "solr_makr/commands/create_core"
-require "solr_makr/commands/destroy_core"
-require "solr_makr/commands/list_cores"
-require "solr_makr/commands/write_yaml"
-require "solr_makr/application"
 
 module SolrMakr
+  extend ActiveSupport::Autoload
+
+  # Executable name.
+  BIN_NAME = 'solr-makr'
+
+  autoload :Application
+  autoload :ApplicationAction
+  autoload :ApplicationDispatch
+  autoload :Collection
+  autoload :Commands
+  autoload :Configsets
+  autoload :Configuration
+  autoload :LocalConfiguration
+  autoload :SolrAPI
+  autoload :SunspotConfiguration
+
+  autoload_under 'errors' do
+    autoload :HaltExecution
+  end
+
+  autoload_under 'meta' do
+    autoload :AbstractRunner
+    autoload :BufferInteraction
+    autoload :DisablePaging
+    autoload :HasSolrAttributes
+    autoload :IndifferentOptions
+    autoload :SetGlobalOptions
+    autoload :OptionDefinition
+    autoload :OptionMapping
+    autoload :Pathlike
+    autoload :Utility
+    autoload :WrapsDirectory
+    autoload :WrapsPath
+  end
+
   class << self
-    TEMPLATE_PATH = Pathname.new(File.dirname(__FILE__)).join('files')
+    delegate :with_zookeeper, to: :configuration
 
-    # @param [String] path
-    # @raise [Errno::ENOENT] if undefined template
-    # @return [String] contents of file
-    def template(path)
-      TEMPLATE_PATH.join(path).read
+    attr_lazy_reader :buffer do
+      SolrMakr::Commands::Buffer.new
+    end
+
+    delegate :logger, to: :buffer
+
+    attr_lazy_reader :configuration do
+      SolrMakr::Configuration.new
+    end
+
+    attr_lazy_reader :root do
+      Pathname.new(__dir__)
+    end
+
+    attr_lazy_reader :files do
+      root.join('solr_makr', 'files')
+    end
+
+    attr_lazy_reader :default_configset do
+      files.join('default-configset')
+    end
+
+    attr_lazy_reader :local_configuration do
+      SolrMakr::LocalConfiguration
     end
   end
 end
+
+Commander::Command::Options.prepend SolrMakr::IndifferentOptions
+Commander::UI.singleton_class.prepend SolrMakr::DisablePaging

data/lib/solr_makr/application.rb

@@ -2,60 +2,40 @@ module SolrMakr
   class Application
     include Commander::Methods
 
-    NAME = 'solr-makr'
+    # @param [IO, File, #write] output
+    def initialize(output: STDOUT)
+      @output       = output
 
-    def run
-      program :name, NAME
-      program :version, SolrMakr::VERSION
-      program :description, 'Create a solr core programmatically'
-      program :help, 'Author', 'Alexa Grey <alexag@hranswerlink.com>'
-      program :help_formatter, Commander::HelpFormatter::TerminalCompact
-
-      default_command :help
-
-      global_option '-d', '--solr-home DIR', 'Path to the solr home directory'
-      global_option '-p', '--solr-port PORT', Integer, 'Port to use to communicate with the solr API'
-      global_option '-H', '--solr-host HOST', String, 'Host [default localhost]'
-      global_option '-V', '--verbose', 'Show verbose output.'
-
-      command :create do |c|
-        c.syntax      = "#{NAME} create NAME"
-
-        c.description = "Create and register a solr core."
-
-        c.when_called Commands::CreateCore, :run!
-      end
-
-      command :list do |c|
-        c.syntax      = "#{NAME} list"
-
-        c.description = "List installed solr cores."
-
-        c.when_called Commands::ListCores, :run!
-      end
+      @exit_status  = 0
+    end
 
-      command :destroy do |c|
-        c.syntax      = "#{NAME} destroy NAME"
+    attr_reader :output
+    attr_reader :exit_status
 
-        c.description = "Unload and remove a solr core."
+    delegate :configuration, to: SolrMakr
 
-        c.when_called Commands::DestroyCore, :run!
+    def run
+      program :name,            SolrMakr::BIN_NAME
+      program :version,         SolrMakr::VERSION
+      program :description,     'Create and manage solr collections via CLI'
+      program :help,            'Author', 'Alexa Grey <alexag@hranswerlink.com>'
 
-        c.option '--purge', 'Purge the solr core\'s instance directory'
-      end
+      default_command :help
 
-      command :yaml do |c|
-        c.syntax      = "#{NAME} yaml NAME"
+      global_option '-Z', '--zookeeper HOST', String,   "Zookeeper host(s) [default: #{configuration.zookeeper}]"
+      global_option '-p', '--solr-port PORT', Integer,  "Port solr is running on [default: #{configuration.solr_port}]"
+      global_option '-H', '--solr-host HOST', String,   "Solr Host [default: #{configuration.solr_host}]"
+      global_option '-V', '--verbose',                  "Show verbose output."
 
-        c.description = 'Print a YAML config for sunspot to stdout'
+      ApplicationDispatch.generate_commands! self
 
-        c.when_called Commands::WriteYaml, :run!
+      run!.tap do |buffer|
+        if buffer.kind_of?(SolrMakr::Commands::Buffer)
+          output.write buffer.to_s
 
-        c.option  '-e', '--env ENVIRONMENT', 'Environment name'
-        c.option  '--log-level LEVEL', String, 'Log level'
+          @exit_status = buffer.exit_status
+        end
       end
-
-      run!
     end
   end
 end

data/lib/solr_makr/application_action.rb

@@ -0,0 +1,182 @@
+module SolrMakr
+  class ApplicationAction
+    include Virtus.model strict: true
+
+    attribute :name,                String
+    attribute :command_name,        String,   default: :default_command_name
+    attribute :description,         String,   default: ''
+    attribute :requires_name,       Boolean,  default: false
+    attribute :multiple_names,      Boolean,  default: false
+    attribute :required_options,    Set,      default: proc { Set.new }
+    attribute :specifies_configset, Boolean,  default: false
+    attribute :interaction,         String,   default: :derive_default_interaction
+
+    delegate :configuration, to: SolrMakr
+
+    # @return [SolrMakr::Commands::Buffer]
+    def execute(args, options)
+      buffer    = SolrMakr::Commands::Buffer.new
+
+      execution = SolrMakr::Commands::Execute.run action: self, command_args: args, command_options: options
+
+      buffer.import execution.buffer
+
+      unless execution.valid?
+        execution.errors.full_messages.each do |error|
+          buffer.error error
+        end
+      end
+
+      return buffer
+    end
+
+    def configure(&block)
+      initial_configuration
+
+      yield Configurator.new(self) if block_given?
+
+      return self
+    end
+
+    # @param [Commander::Command] command
+    # @return [void]
+    def setup_command!(command)
+      command.syntax = "#{SolrMakr::BIN_NAME} #{command_name}"
+
+      if description.present?
+        command.description = description
+      end
+
+      add_options_to! command
+
+      format_command! command
+
+      command.when_called self, :execute
+    end
+
+    def requires?(option_name)
+      option_mapping[option_name].try(:required?)
+    end
+
+    # @api private
+    # @param [<String>] args
+    # @param [Commander::Command::Options] options
+    # @return [void]
+    def set_default_options!(args, options)
+      option_mapping.each do |option|
+        option.set_default!(args, options)
+      end
+
+      if default_options_formatter.respond_to?(:call)
+        instance_exec(args, options, &default_options_formatter)
+      end
+
+      return nil
+    end
+
+    # @api private
+    # @param [Commander::Command] command
+    # @return [void]
+    def format_command!(command)
+      if command_formatter.respond_to?(:call)
+        command_formatter.call(command)
+      end
+
+      return nil
+    end
+
+    # @!attribute [r] interaction_klass
+    # @return [Class]
+    attr_lazy_reader :interaction_klass do
+      "SolrMakr::Commands::#{interaction}".constantize
+    end
+
+    # @!attribute [rw] default_options_formatter
+    # @api private
+    # @return [Proc]
+    attr_accessor :default_options_formatter
+
+    # @!attribute [rw] command_formatter
+    # @api private
+    # @return [Proc]
+    attr_accessor :command_formatter
+
+    attr_lazy_reader :option_mapping do
+      SolrMakr::OptionMapping.new
+    end
+
+    # @param [Symbol] name
+    # @param [Hash] attributes
+    # @yieldparam [SolrMakr::OptionDefinition] option
+    # @yieldreturn [void]
+    def add_option!(name, **attributes, &configurator)
+      attributes[:name] = name
+
+      option = SolrMakr::OptionDefinition.new(attributes)
+
+      yield option if block_given?
+
+      option_mapping << option
+
+      return nil
+    end
+
+    # @api private
+    # @return [String]
+    def derive_default_interaction
+      name.to_s.classify
+    end
+
+    # @param [Commander::Command] command
+    # @return [void]
+    def add_options_to!(command)
+      option_mapping.add_to_command! command
+    end
+
+    # @api private
+    # @return [String]
+    def default_command_name
+      name.to_s.gsub(/_collections?\z/, '').humanize.downcase
+    end
+
+    # @!attribute [r] initial_configuration
+    # @return [nil]
+    attr_lazy_reader :initial_configuration do
+      if requires_name?
+        add_option! :name, short_name: 'n', description: 'Name of the collection', type: String, required: true
+      end
+
+      if specifies_configset?
+        add_option! :configset, value_name: 'NAME', description: 'Name of the configset', type: String, required: true do |c|
+          c.default_value = proc { SolrMakr.configuration.default_configset }
+        end
+      end
+    end
+
+    # @api private
+    class Configurator
+      def initialize(action)
+        @action = action
+      end
+
+      def description(new_description)
+        @action.description = new_description.to_s
+      end
+
+      def format_command(&formatter)
+        @action.command_formatter = formatter
+      end
+
+      def default_options(&formatter)
+        @action.default_options_formatter = formatter
+      end
+
+      def option(name, **attributes, &configurator)
+        @action.add_option!(name, **attributes, &configurator)
+      end
+
+      private
+      attr_reader :action
+    end
+  end
+end