parsley-store 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dmitry Mozzherin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= parsley-store
+
+This gem allows to dramatically increase speed of 'parsing' scientific names. 
+It stores parsed strings in Redis database and does not repeat work already done
+
+== Installation
+  
+  Make sure you have Redis installed on your localhost
+
+  gem install parsley-store
+
+== Usage
+
+  parser = ParsleyStore.new
+  parser.parse('Homo sapiens sapiens Linn. 1758)
+  parser.parse('Homo sapiens sapiens Linn. 1758)
+
+The second parse must be much faster!
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Dmitry Mozzherin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "parsley-store"
+    gem.summary = %Q{Scientific Names Parser with Cached Results}
+    gem.description = %Q{Scientific names parser/atomizer with cached distributed storage of atomized data}
+    gem.email = "dmozzherin@gmail.com"
+    gem.homepage = "http://github.com/GlobalNamesArchitecture/parsley-store"
+    gem.authors = ["Dmitry Mozzherin"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "cucumber", ">= 0"
+    gem.add_dependency "biodiversity"
+    gem.add_dependency "redis"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "parsley-store #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/parsley-store

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+puts 'it will be command line interface to configure and operate parsley store'

data/features/parsley-store.feature

@@ -0,0 +1,14 @@
+Feature: Cached parsind of Scientific Names
+  In order to be able to parse scientific names super fast
+  A user should be able to parse and cache and retrieve results
+  So I want to implement Redis backend to a parser
+
+  Scenario: Connecting to local redis database
+    Given Redis server is running locally
+    Then I get "LOCAL" and "SLAVE" databases connection
+
+  Scenario: "Parsing a name by parser and from database"
+    Given a clean local database
+    When I parse a name "Homo sapiens sapiens (Linn.) 1758" two times
+    Then second parse should be much faster
+    

data/features/step_definitions/parsley-store_steps.rb

@@ -0,0 +1,37 @@
+require 'socket'
+
+Given /^Redis server is running locally$/ do
+  lambda do
+    socket = TCPSocket.open('localhost', 6379)
+    socket.close
+  end.should_not raise_error 
+  @conn = Redis.new
+end
+
+Then /^I get "([^"]*)" and "([^"]*)" databases connection$/ do |local, slave|
+  @conn.select(eval("ParsleyStore::#{slave}")).should == "OK"
+  @conn.select(eval("ParsleyStore::#{local}")).should == "OK"
+  lambda { @conn.select(200) }.should raise_error
+end
+
+Given /^a clean local database$/ do
+  @conn = Redis.new
+  @conn.select(ParsleyStore::LOCAL)
+  @conn.flushdb
+  @conn.dbsize.should == 0
+  @parser = ParsleyStore.new
+end
+
+When /^I parse a name "([^"]*)" two times$/ do |name|
+  now = Time.now
+  res = @parser.parse(name)
+  @delta1 = Time.now - now
+  now = Time.now
+  res = @parser.parse(name)
+  @delta2 = Time.now - now
+end
+
+Then /^second parse should be much faster$/ do
+  (@delta1/@delta2).should > 10
+end
+

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'parsley-store'
+
+require 'spec/expectations'

data/lib/parsley-store.rb

@@ -0,0 +1,28 @@
+require 'redis'
+require 'biodiversity'
+
+
+class ParsleyStore
+  #database numbers for Redis
+  LOCAL = 1
+  SLAVE = 2
+  
+  def initialize
+    @parser = ScientificNameParser.new
+    @local = Redis.new
+    @local.select(LOCAL)
+  end
+
+  def parse(scientific_name)
+    stored = @local.get(scientific_name)
+    return stored if stored
+    begin
+      parsed = @parser.parse(scientific_name)
+    rescue
+      @parser = ScientificNameParser.new
+      parsed = @parser.parse(scientific_name)
+    end
+    @local.set scientific_name, parsed
+    parsed
+  end
+end

data/spec/parsley-store_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ParsleyStore" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'parsley-store'
+require 'spec'
+require 'spec/autorun'
+
+puts "You need to start Redis server on your machine"
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: parsley-store
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dmitry Mozzherin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-10 00:00:00 -04:00
+default_executable: parsley-store
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: biodiversity
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Scientific names parser/atomizer with cached distributed storage of atomized data
+email: dmozzherin@gmail.com
+executables: 
+- parsley-store
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/parsley-store
+- features/parsley-store.feature
+- features/step_definitions/parsley-store_steps.rb
+- features/support/env.rb
+- lib/parsley-store.rb
+- spec/parsley-store_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/GlobalNamesArchitecture/parsley-store
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Scientific Names Parser with Cached Results
+test_files: 
+- spec/parsley-store_spec.rb
+- spec/spec_helper.rb