gares 2.0.0.pre.pre → 2.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f87e7dc8b8d185548c8dcc4c12c789e07802caea
-  data.tar.gz: 971aa5a58e033f79d41f901899bc6d862c56f5f0
+  metadata.gz: a3462299801d297e26ac19012e511cb92b71257b
+  data.tar.gz: 2402a19990a9bf1f1e1b8334b24126a08c368439
 SHA512:
-  metadata.gz: 4432ec3fa4011d82f5b22f63aa647e7b75fca52fa2222335032f9cbb0b5078bcb59008d9d9bfd4fe9474143248d212beac197c2c5758b871519968bed5a8fd38
-  data.tar.gz: 9afd2bd055b35a12e10b15b10d9a29c4208744c0ae1a119c39403f4b8ccfb9ad06c66e1f6d92c8b6bdd09113e6d9c9a068ee9b41412cbad0586127a4ced2f589
+  metadata.gz: 79d40ec3a9d068bd76716cf73e1de3c45f4ea439663fbfeb2cee2588ca8c4fc428652db6f52ed4532d91bfbbbf5cbbd85ba888b848d91d0e6001539f2817cee1
+  data.tar.gz: dbfd7ea33abbb67f5334f81834ef8d9d652d9ef232acf3e36ce94bd6feed2265b69860cf26a7b6f8a9bf1babba29d3e5344c5c1ad8d683e2f2b7033d6239a664

data/gares.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'smarter_csv', '~> 1.0'
   s.add_dependency 'unidecoder', '~> 1.1'
   s.add_dependency 'httparty', '~> 0.13'
+  s.add_dependency 'trie'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/lib/attribute_accessors.rb

@@ -0,0 +1,47 @@
+# Fork of https://raw.githubusercontent.com/rails/rails/master/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
+class Module
+  def mattr_reader(*syms)
+    syms.each do |sym|
+      raise NameError.new("invalid attribute name: #{sym}") unless sym =~ /^[_A-Za-z]\w*$/
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        @@#{sym} = nil unless defined? @@#{sym}
+
+        def self.#{sym}
+          @@#{sym}
+        end
+      EOS
+
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+      class_variable_set("@@#{sym}", yield) if block_given?
+    end
+  end
+
+  def mattr_writer(*syms)
+    syms.each do |sym|
+      raise NameError.new("invalid attribute name: #{sym}") unless sym =~ /^[_A-Za-z]\w*$/
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        @@#{sym} = nil unless defined? @@#{sym}
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+      send("#{sym}=", yield) if block_given?
+    end
+  end
+
+  def mattr_accessor(*syms, &blk)
+    mattr_reader(*syms, &blk)
+    mattr_writer(*syms, &blk)
+  end
+end

data/lib/gares/search.rb

@@ -1,13 +1,16 @@
+require 'trie'
+
 module Gares
   # Search Gares-en-mouvement for a station name
   class Search < StationList
+    @@trie = nil
+    mattr_reader :trie
+
     attr_reader :query
 
     # This is the stations database from capitainetrain.com
     GARES_LIST_URL = "https://raw.githubusercontent.com/capitainetrain/stations/master/stations.csv"
 
-    # List of keywords to ignore while searching
-    IGNORE_KEYWORDS = ["ST", "SAINT", "GARE", "SNCF"]
     # Initialize a new Station search with the specified query
     #
     #   search = Gares::Search.new("Aix")
@@ -29,41 +32,46 @@ module Gares
       @stations ||= (exact_match? ? parse_station : parse_stations)
     end
 
+    def self.find(str)
+      trie.find_prefix(str)
+    end
+
     private
 
     def result
-      @raw_result ||= case @by
-      when :name
-        keywords = @query.to_ascii.split(/[ -]/).select { |keyword| !IGNORE_KEYWORDS.include?(keyword.upcase) }
-        regexp_query = keywords.join(".*")
-        self.class.data(@by).select do |index, v|
-          index && index =~ /#{regexp_query}/i
-        end
-      when :sncf_id
-        { @query.downcase => self.class.data(@by)[@query.downcase] }
+      query = self.class.simplify(@query)
+      if @raw_results.nil?
+        @raw_results = self.class.find(query).values
+        # try first keyword if nothing found
+        @raw_results = @raw_results.empty? ? self.class.find(query.split(" ").first).values : @raw_results
       end
-
-      @result ||= @raw_result.map { |_, raw_station| Gares::Station.new(raw_station) }
+      @result ||= @raw_results.map { |raw_station| Gares::Station.new(raw_station) }
     end
 
-    # Read stations.csv file into memory
-    # @param index either :name or :sncf_id
-    # @return [Hash<String, Hash>] list of stations indexed in a Hash
-    def self.data(index)
-      @@raw_data ||= SmarterCSV.process(open(GARES_LIST_URL), col_sep: ";")
-      case index
-      when :name
-        @@data_by_name ||= index_data(@@raw_data, index)
-      when :sncf_id
-        @@data_by_sncf_id ||= index_data(@@raw_data, index)
-      end
+    def self.simplify(str)
+      str.to_ascii.downcase
+        .gsub(/\bsaint\b/, "st")
+        .gsub(/[^a-z]/, " ")
+        .gsub(/\s+/, " ")
+        .strip
     end
 
-    def self.index_data(data, by)
-      data.map do |raw_station|
-        [raw_station[by].to_ascii.downcase, raw_station] if raw_station[by] && raw_station[:uic]
-      end.compact.to_h
+    # Read stations.csv file into memory into a Trie data structure
+    def self.load_data
+      if @@trie.nil?
+        raw_data ||= SmarterCSV.process(open(GARES_LIST_URL), col_sep: ";")
+        trie = Trie.new
+
+        raw_data.each do |raw_station|
+          next if raw_station[:name].nil? || raw_station[:sncf_id].nil? || raw_station[:uic].nil?
+          trie.insert(simplify(raw_station[:name]), raw_station)
+          trie.insert(simplify(raw_station[:sncf_id]), raw_station)
+        end
+
+        @@trie = trie
+      end
     end
+    load_data
 
     def parse_station
       [result.first]

data/lib/gares/version.rb

@@ -1,3 +1,3 @@
 module Gares
-  VERSION = '2.0.0-pre'
+  VERSION = '2.0.0-1'
 end

data/lib/gares.rb

@@ -9,6 +9,8 @@ require 'hashie'
 require 'smarter_csv'
 require 'unidecoder'
 require 'httparty'
+require 'attribute_accessors'
+require 'string_extensions'
 
 require 'gares/errors'
 require 'gares/base'
@@ -17,7 +19,6 @@ require 'gares/station_list'
 require 'gares/sales'
 require 'gares/services'
 require 'gares/search'
-require 'gares/string_extensions'
 require 'gares/train'
 require 'gares/train_stop'
 require 'gares/version'

data/lib/string_extensions.rb

@@ -0,0 +1,20 @@
+require 'cgi'
+
+module StringExtensions
+  # Unescape HTML
+  def unescape_html
+    CGI.unescapeHTML(encode('UTF-8'))
+  end
+
+  # Strip tags
+  def strip_tags
+    gsub(/<\/?[^>]*>/, '')
+  end
+
+  # Strips out whitespace then tests if the string is empty.
+  def blank?
+    strip.empty?
+  end unless method_defined?(:blank?)
+end
+
+String.send :include, StringExtensions

data/spec/gares/search_spec.rb

@@ -4,15 +4,15 @@ describe Gares::Search do
   describe "search by station name" do
     context 'with multiple search results' do
       subject do
-        Gares::Search.new('étienne')
+        Gares::Search.new('saint étienne')
       end
 
       it 'should remember the query' do
-        expect(subject.query).to eql('étienne')
+        expect(subject.query).to eql('saint étienne')
       end
 
-      it 'should find 28 results' do
-        expect(subject.stations.size).to eql(12)
+      it 'should find 11 results' do
+        expect(subject.stations.size).to eql(11)
       end
 
       it 'should return Gares::Station objects only' do
@@ -32,7 +32,7 @@ describe Gares::Search do
       subject { Gares::Station.search('Saone').first }
 
       it 'should give the proper name' do
-        expect(subject.name).to eql('Port-sur-Saône')
+        expect(subject.name).to eql('Saône')
       end
     end
 
@@ -82,7 +82,7 @@ describe Gares::Search do
 
         it 'should return the gare sncf_id.downcase correctly' do
           subject = Gares::Station.search('MONTELIMAR GARE SNCF')
-          expect(subject.first.sncf_id.downcase).to eql('frxmk')
+          expect(subject.first.sncf_id.downcase).to eql('frmtl')
         end
 
         it 'should return the gare sncf_id.downcase correctly' do

data/spec/gares/train_spec.rb

@@ -98,7 +98,7 @@ describe Gares::Train do
       expect(subject.departure.delayed?).to be(false)
     end
 
-    it "has stops", focus: true do
+    it "has stops" do
       expect(subject.stops.size).to eq(7)
       expect(subject.stops.first.station.name).to eq('Nogent-sur-Seine')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gares
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.pre
+  version: 2.0.0.pre.1
 platform: ruby
 authors:
 - Paul Bonaud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: trie
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +224,7 @@ files:
 - README.md
 - Rakefile
 - gares.gemspec
+- lib/attribute_accessors.rb
 - lib/gares.rb
 - lib/gares/base.rb
 - lib/gares/errors.rb
@@ -218,10 +233,10 @@ files:
 - lib/gares/services.rb
 - lib/gares/station.rb
 - lib/gares/station_list.rb
-- lib/gares/string_extensions.rb
 - lib/gares/train.rb
 - lib/gares/train_stop.rb
 - lib/gares/version.rb
+- lib/string_extensions.rb
 - spec/fixtures/frabt
 - spec/fixtures/frabt-services-vente
 - spec/fixtures/frhco

data/lib/gares/string_extensions.rb

@@ -1,22 +0,0 @@
-require 'cgi'
-
-module Gares #:nordoc:
-  module StringExtensions
-    # Unescape HTML
-    def unescape_html
-      CGI.unescapeHTML(encode('UTF-8'))
-    end
-
-    # Strip tags
-    def strip_tags
-      gsub(/<\/?[^>]*>/, '')
-    end
-
-    # Strips out whitespace then tests if the string is empty.
-    def blank?
-      strip.empty?
-    end unless method_defined?(:blank?)
-  end
-end
-
-String.send :include, Gares::StringExtensions