thinking-sphinx-ports 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04bfdccc29ef14537c8bd6a55a2493cbfd158cb2
+  data.tar.gz: b154701d70bafeb7306115be91013fcb3fe28c13
+SHA512:
+  metadata.gz: 414968762671612f16998f4c974052c55d68ff75709a16534f396c171ec2ef0b5135728833c5c1977887321e5fa46ba2f377ef115a66d0d0a66d4a9645ca9741
+  data.tar.gz: 59045b2cd011d3c00b74b20eab4bc0e4021381d19677aaf7af0dfc8e58d81a4a96b0c92bd9727ff421f4e982a9f24415bf4489777cfd0beccc3d778197b6dbb8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.markdown

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at pat@freelancing-gods.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.markdown

@@ -0,0 +1,44 @@
+# ThinkingSphinx::Ports
+
+Automatically assign Sphinx ports to multiple apps using Thinking Sphinx on the one machine. This is useful if you have many apps on your development machine that use Sphinx and Thinking Sphinx, and you don't want to worry about making sure the port you've assigned for it isn't being used elsewhere.
+
+This library is aimed development and test environments - each app and environment gets a unique port, to avoid any conflicts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thinking-sphinx-ports', '~> 0.1.0', :groups => [:development, :test]
+```
+
+**This gem is not meant for use in production environments.** Indeed, it may override your environment-specific settings, so make sure you be specific in the environments it should be loaded within.
+
+## Usage
+
+Beyond adding it to your Gemfile, there's nothing else you need to do for Rails applications. Thinking Sphinx will automatically be assigned a unique port based on its environment and path.
+
+If you have Sphinx daemons running on your machine already, stopping those daemons and then running `rake ts:configure ts:start` is recommended - this will have the daemon using their newly assigned port.
+
+If you want to use this gem with non-Rails apps, then you'll want something along the lines of this code to run while you're app is booting up:
+
+```ruby
+# for non-Rails apps only
+ThinkingSphinx::Ports.call [Dir.pwd, ENV['RACK_ENV']]
+```
+
+Modify those variables as you wish - the important part is that overall argument for `ThinkingSphinx::Ports.call` be unique for the given app and environment.
+
+For the extra curious, the path/environment and port pairings are saved to `~/.thinking_sphinx_ports.yml`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pat/thinking-sphinx-ports. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Licence
+
+Copyright (c) 2016, ThinkingSphinx::Ports is developed and maintained by Pat Allan, and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "thinking_sphinx/ports"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/thinking-sphinx-ports.rb

@@ -0,0 +1 @@
+require 'thinking_sphinx/ports'

data/lib/thinking_sphinx/ports.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+require 'rails/railtie'
+require 'thinking_sphinx'
+
+module ThinkingSphinx::Ports
+  PATH = File.expand_path '~/.thinking_sphinx_ports.yml'
+
+  def self.call(key, collection = nil, configuration = nil)
+    collection    ||= default_collection
+    configuration ||= ThinkingSphinx::Configuration.instance
+
+    port = collection.call key
+
+    configuration.settings['mysql41'] = port
+    configuration.searchd.mysql41     = port
+  end
+
+  def self.default_collection
+    @@default_collection ||= begin
+      Collection.new Read.new(PATH), Write.new(PATH)
+    end
+  end
+end
+
+require 'thinking_sphinx/ports/collection'
+require 'thinking_sphinx/ports/key'
+require 'thinking_sphinx/ports/railtie'
+require 'thinking_sphinx/ports/read'
+require 'thinking_sphinx/ports/write'

data/lib/thinking_sphinx/ports/collection.rb

@@ -0,0 +1,29 @@
+class ThinkingSphinx::Ports::Collection
+  FIRST_PORT = 9320
+
+  def initialize(reader, writer)
+    @reader, @writer = reader, writer
+  end
+
+  def call(key)
+    mappings[key] || next_port_for(key)
+  end
+
+  private
+
+  attr_reader :reader, :writer
+
+  def mappings
+    @mappings ||= reader.call
+  end
+
+  def next_port_for(key)
+    mappings[key] = next_port
+    writer.call mappings
+    mappings[key]
+  end
+
+  def next_port
+    (mappings.values.max || FIRST_PORT) + 1
+  end
+end

data/lib/thinking_sphinx/ports/key.rb

@@ -0,0 +1,5 @@
+class ThinkingSphinx::Ports::Key
+  def self.call(app)
+    [Rails.root.to_s, Rails.env.to_s]
+  end
+end

data/lib/thinking_sphinx/ports/railtie.rb

@@ -0,0 +1,5 @@
+class ThinkingSphinx::Ports::Railtie < Rails::Railtie
+  initializer "thinking_sphinx_ports.set_port" do |app|
+    ThinkingSphinx::Ports.call ThinkingSphinx::Ports::Key.call(app)
+  end
+end

data/lib/thinking_sphinx/ports/read.rb

@@ -0,0 +1,15 @@
+class ThinkingSphinx::Ports::Read
+  def initialize(path)
+    @path = path
+  end
+
+  def call
+    return {} unless File.exist?(path)
+
+    YAML.load File.read(path)
+  end
+
+  private
+
+  attr_reader :path
+end

data/lib/thinking_sphinx/ports/write.rb

@@ -0,0 +1,13 @@
+class ThinkingSphinx::Ports::Write
+  def initialize(path)
+    @path = path
+  end
+
+  def call(data)
+    File.write path, YAML.dump(data)
+  end
+
+  private
+
+  attr_reader :path
+end

data/thinking-sphinx-ports.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "thinking-sphinx-ports"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Pat Allan"]
+  spec.email         = ["pat@freelancing-gods.com"]
+
+  spec.summary       = %q{Assign unique ports to Thinking Sphinx automatically.}
+  spec.homepage      = "http://github.com/pat/thinking-sphinx-ports"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |file|
+    file.match(%r{^(test|spec|features)/})
+  }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'thinking-sphinx', '~> 3.0'
+  spec.add_runtime_dependency 'railties'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: thinking-sphinx-ports
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thinking-sphinx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.markdown
+- Gemfile
+- README.markdown
+- Rakefile
+- bin/console
+- bin/setup
+- lib/thinking-sphinx-ports.rb
+- lib/thinking_sphinx/ports.rb
+- lib/thinking_sphinx/ports/collection.rb
+- lib/thinking_sphinx/ports/key.rb
+- lib/thinking_sphinx/ports/railtie.rb
+- lib/thinking_sphinx/ports/read.rb
+- lib/thinking_sphinx/ports/write.rb
+- thinking-sphinx-ports.gemspec
+homepage: http://github.com/pat/thinking-sphinx-ports
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Assign unique ports to Thinking Sphinx automatically.
+test_files: []
+has_rdoc: