london-bike-hire-cli 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a31585a5f453c569a80dc06e07b7c2ff6fbda20f
-  data.tar.gz: 94dab876d1d9638e36f5d8415246ef0b70dcad0d
+  metadata.gz: d671c2c0f1e169a21f29d72549a428bb33611d4c
+  data.tar.gz: 3f32c3f533b6a18741d28e57275a289762b3260d
 SHA512:
-  metadata.gz: d7b7c87317e34fc58ccbb8e867ffa553662245f07e6c26f2680dfbbc0d471a7db7106d099fd9a7b1ca08206bf3d0c934195874ef7bf59fe2f89d11eae9ddf241
-  data.tar.gz: d954e6c03befdd669094c432ef7a5c1131104f4d88b8526a329c8f6b98dd6ccae1cfcf1c556ecb4453203a77143a14206b6f3bfc0dd3b2016a0963aa676cd400
+  metadata.gz: 664bcbc0ebcbf7fe0ad5b3af52961f186f618928eb84dc4c9c571742052da197e92a6a8bb93addba70927a9c028ecc8b575f646351a89abe00d71643a7a40f86
+  data.tar.gz: 3665a466b1f0d4d2a3d08ca212ebbf401be996c3e99cf8a3f4dd5858732ed7498425cfa6d598a8349a67d379e3b16be0ca6c03279a8f2ca1f3d018b43845ef7e

data/.ruby-version

@@ -1 +1 @@
-2.1.1
+2.2.0

data/.travis.yml

@@ -3,6 +3,7 @@ cache: bundler
 rvm:
   - 2.0.0
   - 2.1.0
+  - 2.2.0
   - ruby-head
 
 matrix:

data/README.md

@@ -4,7 +4,7 @@
 
 [![Build Status](https://travis-ci.org/rob-murray/london-bike-hire-cli.svg?branch=master)](https://travis-ci.org/rob-murray/london-bike-hire-cli)
 [![Code Climate](https://codeclimate.com/github/rob-murray/london-bike-hire-cli.png)](https://codeclimate.com/github/rob-murray/london-bike-hire-cli)
-[![Coverage Status](https://coveralls.io/repos/rob-murray/london-bike-hire-cli/badge.png)](https://coveralls.io/r/rob-murray/london-bike-hire-cli)
+[![Coverage Status](https://coveralls.io/repos/rob-murray/london-bike-hire-cli/badge.svg?branch=master)](https://coveralls.io/r/rob-murray/london-bike-hire-cli?branch=master)
 [![Dependency Status](https://gemnasium.com/rob-murray/ferver.svg)](https://gemnasium.com/rob-murray/london-bike-hire-cli)
 [![Gem Version](https://badge.fury.io/rb/london-bike-hire-cli.svg)](http://badge.fury.io/rb/london-bike-hire-cli)
 [![Haz Commitz Status](http://haz-commitz.herokuapp.com/repos/rob-murray/london-bike-hire-cli.svg)](http://haz-commitz.herokuapp.com/repos/rob-murray/london-bike-hire-cli)
@@ -12,17 +12,19 @@
 
 ### Description
 
-This gem provides a command line interface to find information about London's Bike Hire stations, it allows you to find stations by name or their ID and retrieve information about the status of a station.
+This gem provides a command line interface to find information about London's Bike Hire stations, it allows you to find stations by name or their ID or a location and retrieve information about the status of a station.
+
+I got fed up digging through [the official map](https://web.barclayscyclehire.tfl.gov.uk/maps) to see which bike stations were free - everyone knows the command line is way more efficient.
 
 ![Boris](boris-on-a-bike_med.jpg?raw=true "Boris Johnson on a bike")
 
 Here's the spec for **London Bike Hire CLI**:
 
-* Find all stations
-* Find nearest station
-* Find by ID
-* Find by by name
-* Display status of stations
+* [Find all stations](#list-all-bike-stations)
+* [Find by ID](#find-a-bike-station-by-id)
+* [Find nearest station](#find-the-nearest-bike-station)
+* [Find by name](#find-all-bike-stations-by-name)
+* [Display status of stations](#results)
 
 
 ### Getting started
@@ -38,7 +40,7 @@ $ gem install london-bike-hire-cli
 
 You can run **london-bike-hire-cli** from the command line with just the `lbh` command.
 
-##### Command line help
+#### Command line help
 
 For a list of arguments just use the `-h` switch.
 
@@ -46,7 +48,7 @@ For a list of arguments just use the `-h` switch.
 $ lbh -h
 ````
 
-##### List all bike stations
+#### List all bike stations
 
 List all however-many-hundred bike stations there are. With pagination.
 
@@ -54,7 +56,7 @@ List all however-many-hundred bike stations there are. With pagination.
 $ lbh all
 ````
 
-##### Find the nearest bike station
+#### Find the nearest bike station
 
 Find a the nearest bike station to the specified type below. This will return five stations.
 
@@ -76,7 +78,7 @@ $ lbh near --id 123
 
 **Note:** Don't forget to wrap search term in quotes if it contains spaces.
 
-##### Show status of a bike station by id
+#### Find a bike station by id
 
 Find a Bike station by it's Tfl station ID. This will return one station.
 
@@ -85,7 +87,7 @@ $ lbh find --id {id}
 $ lbh find --id 439
 ````
 
-##### Find all bike stations by name
+#### Find all bike stations by name
 
 Search all bike stations' name attribute for the search value. This will return zero or more results.
 
@@ -94,22 +96,22 @@ $ lbh where --{attribute} {search_value}
 $ lbh where --name kings
 ````
 
-##### Results
+#### Results
 
 ```bash
 $ lbh find --id 439
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-Feed updated: 2014-08-12 08:45:01
->>> Dock
+----- Bike station
 Id: 439
 Name: Killick Street, Kings Cross
 Lat: 51.5338
 Long: -0.118677
 Temporary: false
-Bikes: 4
-Docks_free: 18
+Bikes: 13
+Docks_free: 9
 Docks_total: 22
 Link to map: https://www.google.co.uk/maps/preview/@51.5338,-0.118677,17z
+Updated at: 2015-03-31 20:46:01
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 ```
 

data/lib/london_bike_hire_cli/application.rb

@@ -65,7 +65,14 @@ module LondonBikeHireCli
     end
 
     def station_repository
-      @station_repository ||= StationRepository.new(FeedParser.new)
+      register_adapter!
+      Repository::StationRepo.new
+    end
+
+    def register_adapter!
+      Repository::Repo.register(
+        Repository::StationStore.new(FeedParser.new.fetch)
+      )
     end
   end
 end

data/lib/london_bike_hire_cli/basic_renderer.rb

@@ -1,38 +1,31 @@
+require 'erb'
+require_relative 'color_helper'
+
 module LondonBikeHireCli
   class BasicRenderer
+    include ColorHelper
+
     def initialize(output = STDOUT)
       @output = output
     end
 
-    def render(context)
-      output.print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
-      output.print "Feed updated: #{context.time_of_feed}\n"
+    attr_reader :context
 
-      context.each do |station|
-        render_station(station)
-      end
-
-      output.print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
-    end
-
-    def render_error(context)
-      output.print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
-      output.print "Ooops, something went wrong with the query.\n"
-      output.print "The query #{context[:query].inspect}\n"
-      output.print "resulted in error: #{context[:error]}\n"
-      output.print "Try again?\n"
+    def render(template_name, context)
+      @context = context
+      output.print render_template(find_template(template_name))
     end
 
     private
 
     attr_reader :output
 
-    def render_station(station)
-      output.print ">>> Dock\n"
-      station.each_pair.each do |attr_name, attr_value|
-        output.print "#{attr_name.capitalize}: #{attr_value}\n"
-      end
-      output.print "Link to map: #{station.map_link}\n"
+    def render_template(template)
+      ERB.new(template).result(binding).gsub(/^\s+/, '')
+    end
+
+    def find_template(template_name)
+      File.read("lib/london_bike_hire_cli/views/#{template_name}.erb")
     end
   end
 end

data/lib/london_bike_hire_cli/color_helper.rb

@@ -0,0 +1,24 @@
+module LondonBikeHireCli
+  module ColorHelper
+    def colorize(text, color_name = :default)
+      colour_code = color_code(color_name)
+      "\e[#{colour_code}m#{text}\e[0m"
+    end
+
+    private
+
+    def color_code(name)
+      COLOR_MAP[name]
+    end
+
+    COLOR_MAP = {
+      default: 39,
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      pink: 35,
+      cyan: 36
+    }.freeze
+  end
+end

data/lib/london_bike_hire_cli/controller.rb

@@ -1,6 +1,6 @@
 module LondonBikeHireCli
   class Controller
-    attr_accessor :geocoder, :spatial_service
+    attr_accessor :geocoder
 
     def initialize(repository: nil, renderer: default_renderer)
       @repository = repository
@@ -10,58 +10,55 @@ module LondonBikeHireCli
 
     def all
       results = repository.all
-      renderer.render(results)
+      renderer.render(:stations, results)
     end
 
     def find_by_id(id)
-      results = repository.find_by_id(id.to_i)
-      renderer.render(results)
+      results = repository.find(id.to_i)
+      renderer.render(:stations, Array(results))
 
-    rescue StationRepository::StationNotFound => e
-      renderer.render_error(query: "find_by_id: #{id}", error: e)
+    rescue StationNotFoundError => e
+      renderer.render(:error, query: "find_by_id: #{id}", error: e)
     end
 
     def where(params: {})
-      results = repository.find_by_name(params[:name])
-      renderer.render(results)
+      by_name_query = Queries::StationsByName.new(params[:name])
+      results = repository.query(by_name_query)
+      renderer.render(:stations, results)
 
-    rescue StationRepository::StationNotFound => e
-      renderer.render_error(query: "where: #{params}", error: e)
+    rescue StationNotFoundError => e
+      renderer.render(:error, query: "where: #{params}", error: e)
     end
 
     def nearest(params: {})
       unless params[:search_term].nil? ^ params[:id].nil?
         error = 'Please use either `search_term` or `id` not both.'
-        renderer.render_error(query: "nearest: #{params}", error: error)
+        renderer.render(:error, query: "nearest: #{params}", error: error)
         return
       end
 
       if search_term = params[:search_term]
         geocoded_point = geocoder.geocode(search_term)
-      end
-
-      if search_term = params[:id]
+      elsif search_term = params[:id]
         begin
-          stations = repository.find_by_id(search_term.to_i)
-        rescue StationRepository::StationNotFound => e
-          renderer.render_error(query: "where: #{params}", error: e)
+          station = repository.find(search_term.to_i)
+        rescue StationNotFoundError => e
+          renderer.render(:error, query: "where: #{params}", error: e)
           return
         end
 
-        geocoded_point = stations.first.position
+        geocoded_point = station.position
       end
 
       unless geocoded_point
         error = 'Unable to Geocode location.'
-        renderer.render_error(query: "nearest: #{params}", error: error)
+        renderer.render(:error, query: "nearest: #{params}", error: error)
         return
       end
 
-      init_spatial_service(repository.all)
-      nearest_ids = spatial_service.nearest(geocoded_point)
-
-      results = repository.find_by_id(*nearest_ids)
-      renderer.render(results)
+      near_query = Queries::StationsNear.new(geocoded_point[:lat], geocoded_point[:long], DEFAULT_SEARCH_LIMIT)
+      results = repository.query(near_query)
+      renderer.render(:stations, results)
     end
 
     private
@@ -71,12 +68,5 @@ module LondonBikeHireCli
     def default_renderer
       BasicRenderer.new
     end
-
-    def init_spatial_service(all_stations)
-      @spatial_service ||= begin
-        datasource = StationAdapter.new(all_stations).to_triples
-        SpatialSearch.new(datasource)
-      end
-    end
   end
 end

data/lib/london_bike_hire_cli/feed_parser.rb

@@ -14,23 +14,21 @@ module LondonBikeHireCli
 
     private
 
-    attr_writer :stations
+    attr_reader :feed_time
 
     def parse_xml(xml_doc)
-      stations = {}
+      stations = []
+      parse_feed_time(xml_doc)
 
       xml_doc.root.elements.each do |node|
-        station = parse_station(node)
-        station_id = station[:id].to_i
-        stations[station_id] = Station.new(station) unless station_id == 0
+        stations << parse_station(node)
       end
-      stations[:last_update] = parse_feed_time(xml_doc)
 
-      stations
+      QueryResponse.new(last_update: feed_time, results: stations)
     end
 
     def parse_feed_time(xml_doc)
-      Time.at xml_doc.root['lastUpdate'].to_i / 1000
+      @feed_time ||= Time.at xml_doc.root['lastUpdate'].to_i / 1000
     end
 
     # <stations lastUpdate="1407153481506" version="2.0">
@@ -64,13 +62,14 @@ module LondonBikeHireCli
         station[:lat] = node.text.to_f if node.node_name.eql? 'lat'
         station[:long] = node.text.to_f if node.node_name.eql? 'long'
         station[:temporary] = parse_bool(node.text) if node.node_name.eql? 'temporary'
+        station[:updated_at] = feed_time
       end
 
-      station
+      Station.new(station)
     end
 
     def parse_bool(value)
-      value == 'true'
+      !!(value == 'true')
     end
   end
 end

data/lib/london_bike_hire_cli/queries/stations_by_name.rb

@@ -0,0 +1,9 @@
+module LondonBikeHireCli
+  module Queries
+    StationsByName = Struct.new(:search_term) do
+      def normalized_query
+        search_term.downcase
+      end
+    end
+  end
+end

data/lib/london_bike_hire_cli/queries/stations_near.rb

@@ -0,0 +1,5 @@
+module LondonBikeHireCli
+  module Queries
+    StationsNear = Struct.new(:lat, :long, :limit)
+  end
+end

data/lib/london_bike_hire_cli/query_response.rb

@@ -1,22 +1,12 @@
-require 'forwardable'
+require 'delegate'
 
 module LondonBikeHireCli
-  class QueryResponse
-    extend Forwardable
-
-    def_delegators :results, :[], :each, :map, :first, :size
+  class QueryResponse < SimpleDelegator
+    attr_reader :last_update
 
     def initialize(last_update: Time.now, results: [])
+      super(results)
       @last_update = last_update
-      @results = results
-    end
-
-    def time_of_feed
-      last_update.strftime('%Y-%m-%d %H:%M:%S')
     end
-
-    private
-
-    attr_reader :results, :last_update
   end
 end

data/lib/london_bike_hire_cli/repository/in_memory_store_adapter.rb

@@ -0,0 +1,69 @@
+module LondonBikeHireCli
+  module Repository
+    # Adapter that stores records in memory.
+    # Supports multiple record types
+    #
+    class InMemoryStoreAdapter
+      def initialize(items = [])
+        @counter = 0
+        @map = {}
+        add_items(items)
+      end
+
+      def create(record)
+        @counter = @counter + 1
+        record.id ||= @counter
+        map_for(record)[record.id] = record
+      end
+
+      def update(record)
+        map_for(record)[record.id] = record
+      end
+
+      def delete(record)
+        map_for(record).delete record.id
+      end
+
+      def find(klass, id)
+        map_for_class(klass).fetch id
+      end
+
+      def find_by_ids(klass, *ids)
+        map_for_class(klass).values_at(*ids)
+      end
+
+      def all(klass)
+        map_for_class(klass).values
+      end
+
+      def query(klass, selector)
+        # TODO fix introspection
+        send "query_#{underscore(selector.class.name)}", klass, selector
+      end
+
+      private
+
+      def add_items(items)
+        items.each { |item| create(item) }
+      end
+
+      def map_for_class(klass)
+        @map[klass.to_s.to_sym] ||= {}
+      end
+
+      def map_for(record)
+        map_for_class(record.class)
+      end
+
+      # TODO fix
+      def underscore(camel_cased_word)
+        demod_word = camel_cased_word.to_s.split('::').last
+        demod_word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        demod_word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        demod_word.tr!('-', '_')
+        demod_word.downcase!
+        demod_word
+      end
+    end
+  end
+end

data/lib/london_bike_hire_cli/repository/repo.rb

@@ -0,0 +1,39 @@
+module LondonBikeHireCli
+  module Repository
+    # Generic Repository delegating to adapter
+    #
+    module Repo
+      class << self
+        attr_reader :adapter
+
+        def register(adapter)
+          @adapter = adapter
+        end
+
+        def find(klass, id)
+          adapter.find klass, id
+        end
+
+        def all(klass)
+          adapter.all klass
+        end
+
+        def create(model)
+          adapter.create(model)
+        end
+
+        def update(model)
+          adapter.update(model)
+        end
+
+        def delete(model)
+          adapter.delete model
+        end
+
+        def query(klass, selector)
+          adapter.query(klass, selector)
+        end
+      end
+    end
+  end
+end

data/lib/london_bike_hire_cli/repository/spatial_search_adapter.rb

@@ -0,0 +1,28 @@
+require "kdtree"
+
+module LondonBikeHireCli
+  module Repository
+    class SpatialSearchAdapter
+      def initialize(stations = [])
+        init_spatial_store(stations)
+      end
+
+      # Public: Return the IDs of the nearest n stations
+      # lat, long - latitude, longitude of point to search
+      # limit - The maximum number of results
+      #
+      def nearest(lat, long, limit)
+        spatial_store.nearestk(lat, long, limit)
+      end
+
+      private
+
+      attr_reader :spatial_store
+
+      def init_spatial_store(stations)
+        stations_triples = stations.map { |station| [station.lat, station.long, station.id] }
+        @spatial_store = Kdtree.new(stations_triples)
+      end
+    end
+  end
+end

data/lib/london_bike_hire_cli/repository/station_repo.rb

@@ -0,0 +1,35 @@
+module LondonBikeHireCli
+  module Repository
+    # Specialisation for Bike Stations; delegates all to Repository
+    #
+    class StationRepo
+      def save(record)
+        Repo.save(record)
+      end
+
+      def all
+        Repo.all object_class
+      end
+
+      def find(id)
+        Repo.find object_class, id
+      end
+
+      def delete(record)
+        Repo.delete record
+      end
+
+      def query(selector)
+        Repo.query object_class, selector
+      end
+
+      private
+
+      def object_class
+        # TODO fix reflection
+        # @object_class ||= self.to_s.match(/^(.+)Repo/)[1].constantize
+        Station
+      end
+    end
+  end
+end

data/lib/london_bike_hire_cli/repository/station_store.rb

@@ -0,0 +1,22 @@
+module LondonBikeHireCli
+  module Repository
+    # Specialisation for Bike Stations; implements specific queries
+    #
+    class StationStore < InMemoryStoreAdapter
+      def query_stations_by_name(klass, query)
+        all(klass).select { |station| station.name.downcase.include?(query.normalized_query) }
+      end
+
+      def query_stations_near(klass, query)
+        matched_ids = spatial_search_adapter(klass).nearest(query.lat, query.long, query.limit)
+        find_by_ids(klass, *matched_ids)
+      end
+
+      private
+
+      def spatial_search_adapter(klass)
+        @spatial_search_adapter ||= SpatialSearchAdapter.new all(klass)
+      end
+    end
+  end
+end

data/lib/london_bike_hire_cli/station.rb

@@ -12,5 +12,9 @@ module LondonBikeHireCli
         long: long
       }
     end
+
+    def display_updated_at
+      updated_at.strftime('%Y-%m-%d %H:%M:%S')
+    end
   end
 end

data/lib/london_bike_hire_cli/station_not_found_error.rb

@@ -0,0 +1,3 @@
+module LondonBikeHireCli
+  class StationNotFoundError < StandardError; end
+end

data/lib/london_bike_hire_cli/version.rb

@@ -1,3 +1,3 @@
 module LondonBikeHireCli
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/lib/london_bike_hire_cli/views/error.erb

@@ -0,0 +1,5 @@
+<%= colorize('>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>', :yellow) %>
+Ooops, something went wrong with the query.
+The query <%= colorize(context[:query].inspect, :red) %>
+resulted in error: <%= colorize(context[:error], :red) %>
+<% colorize('Try again?', :cyan) %>

data/lib/london_bike_hire_cli/views/stations.erb

@@ -0,0 +1,11 @@
+<%= colorize('>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>', :yellow) %>
+<% context.each do |station| %>
+----- <%= colorize('Bike station', :green) %>
+<% station.each_pair.each do |attr_name, attr_value| %>
+<% next if attr_name == :updated_at %>
+<%= attr_name.capitalize %>: <%= colorize(attr_value, :cyan) %>
+<% end %>
+Link to map: <%= colorize(station.map_link, :pink) %>
+Updated at: <%= colorize(station.display_updated_at, :red) %>
+<% end %>
+<%= colorize('>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>', :yellow) %>