reality 0.0.5 → 0.1.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 725f78139506531415afc4cdd24927ae8845eecf
-  data.tar.gz: 1260575c3e637ec2e1c032dd894b4985dad78450
+  metadata.gz: 24c33c49cda89a8110ce9d9701ef5bf38fb57388
+  data.tar.gz: c0a2a02b421cb1c2913514582add91176599a75c
 SHA512:
-  metadata.gz: a25e4eb32e02b862a5667e08493fe7a5128bfa97a0b69436f37040a27ff5752ed47417ec3588e7659ebf189ebb1a658016bd9f8e5815ad8f40ebb95a365752fe
-  data.tar.gz: c52eebc26b43a1cc2c4e885920138fcd9841a3bedb747f1ec9e04a45bf895d0cc5869d8e3d4eb620399cc3e8618299c0219b97b6f4101ff7c1d8cc414f9582eb
+  metadata.gz: d12dd6391fdf5452d8e6d9730d4d644f59706271478ce7063c6c17c4f5971f07f99ef6c59f21b409852e0dd5e66aa08295f690ef4b7de914781764f2b8f29cef
+  data.tar.gz: 5e3997ba06cf37480b98133261ded11b0671eeccdfd3ce25d9f75eab7df54e214e40491160e50060ed48751848ab744c263992253b0cf3d355978021049a0c30

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# Reality chaotich changelog
+
+## 0.1.0.alpha - 2018-02-09
+
+Pre-release of completely rewritten version. Still a long way to go before proper release, it will be
+described here properly at its time.
+
 ## 0.0.4 - 2016-04-18
 
 * Economic indicators from Quandl;

data/README.md

@@ -2,232 +2,21 @@ Reality
 =======
 
 [![Gem Version](https://badge.fury.io/rb/reality.svg)](http://badge.fury.io/rb/reality)
-[![Build Status](https://travis-ci.org/molybdenum-99/reality.svg?branch=master)](https://travis-ci.org/molybdenum-99/reality)
 [![Join the chat at https://gitter.im/molybdenum-99/reality](https://badges.gitter.im/molybdenum-99/reality.svg)](https://gitter.im/molybdenum-99/reality?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 **Reality** is your quick access point to almost any entity existing in
 real world (and described in Wikipedia). Its goal is to make the world
 inspectable and computable.
 
-## Table Of Contents
+**!!!IMPORTANT!!!** This is **pre-release** of new, completely rewritten version. Previos version
+turned to be a (nice-looking) dead end. It still can be found at [old-prototype](https://github.com/molybdenum-99/reality/tree/old-prototype-branch)
+branch, and installed as a gem version 0.0.5.
 
-* [Showcase](#showcase)
-* [Is it real? Is it really working?.. But how?](#is-it-real-is-it-really-working-but-how)
-* [Why/when do I need this?..](#whywhen-do-i-need-this)
-* [Uhm, ok. How to use it?](#uhm-ok-how-to-use-it)
-  * [...from your code](#from-your-code)
-  * [...from command-line](#from-command-line)
-  * [...from interactive console](#from-interactive-console)
-* [Good. What next?..](#good-what-next)
-* [Docs](#docs)
-* [Want to help?](#want-to-help)
-* [Compatibility](#compatibility)
-* [Credits](#credits)
-* [License](#license)
+Current state is very WIP and prerelease is made for people to play at [RubyConf India 2018](http://rubyconfindia.org/)
+(TODO: insert link to slides/video after the talk.)
 
-## Showcase
+Stay tuned for large and important updates!
 
-```ruby
-# Like this
-require 'reality'
-include Reality
-
-ar = Entity('Argentina')
-ar.cities.load!
-#  => #<Reality::List[Buenos Aires, "Córdoba, Argentina", "Rosario, Santa Fe", "Mendoza, Argentina", La Plata, San Miguel de Tucumán, Mar del Plata, Salta, "Santa Fe, Argentina", "San Juan, Argentina", "Resistencia, Chaco", Neuquén, Santiago del Estero, Corrientes, Avellaneda, Bahía Blanca, San Salvador de Jujuy, Quilmes, Lanús, Comodoro Rivadavia, "Concordia, Entre Ríos"]>
-ar.cities.map{|city| city.coord.distance_to(ar.capital)}
-# => [#<Reality::Measure(0.0 km)>, #<Reality::Measure(646 km)>, #<Reality::Measure(278 km)>, #<Reality::Measure(985 km)>, #<Reality::Measure(54 km)>, #<Reality::Measure(1,084 km)>, #<Reality::Measure(385 km)>, #<Reality::Measure(1,285 km)>, #<Reality::Measure(394 km)>, #<Reality::Measure(1,005 km)>, #<Reality::Measure(797 km)>, #<Reality::Measure(987 km)>, #<Reality::Measure(942 km)>, #<Reality::Measure(793 km)>, #<Reality::Measure(7 km)>, #<Reality::Measure(574 km)>, #<Reality::Measure(1,338 km)>, #<Reality::Measure(16 km)>, #<Reality::Measure(11 km)>, #<Reality::Measure(1,471 km)>, #<Reality::Measure(358 km)>] 
-
-# or this
-matz = Entity('Yukihiro Matsumoto')
-# => #<Reality::Entity(Yukihiro Matsumoto):person>
-matz.describe
-# ---------------------------------------------
-# #<Reality::Entity(Yukihiro Matsumoto):person>
-# ---------------------------------------------
-#      awards: #<Reality::List[FSF Free Software Awards?]>
-# birth_place: #<Reality::Entity?(Ōsaka Prefecture)>
-#    birthday: #<Date: 1965-04-14>
-# citizenship: #<Reality::Entity?(Japan)>
-# occupations: ["scientist", "engineer", "computer scientist", "programmer"]
-#         sex: "male"
-
-matz.birth_place.population
-# => #<Reality::Measure(8,847,838 person)>
-matz.birth_place.neighbours.map(&:population)
-# => [#<Reality::Measure(2,610,073 person)>, #<Reality::Measure(5,522,917 person)>, #<Reality::Measure(1,372,046 person)>, #<Reality::Measure(961,320 person)>, #<Reality::Measure(119,291 person)>]
-matz.birth_place.coord.weather
-# => #<Reality::Weather(-0.91°C, Clear)>
-
-# or maybe this?
-beatles = Entity('Beatles').parts
-# => #<Reality::List[John Lennon?, Sir. Paul McCartney?, Ringo Starr?, George Harrison?, Stuart Sutcliffe?, Pete Best?]>
-beatles.load!
-beatles.select(&:alive?)
-# => #<Reality::List[Paul McCartney, Ringo Starr, Pete Best]> 
-beatles.select(&:alive?).map{|beatle| beatle.albums && beatle.albums.last}
-# => [#<Reality::Entity?(New (album))>, #<Reality::Entity?(Old Wave)>, nil]
-
-# and stuff
-t2 = Entity('Terminator 2')
-t2.actors.each do |actor|
-  puts "#{ actor.name }: #{ actor.age_at(t2.published_at) }"
-end
-# Edward Furlong: 13
-# Arnold Schwarzenegger: 43
-# Linda Hamilton: 34
-# Robert Patrick: 32
-```
-
-## Is it real? Is it really working?.. But how?
-
-Yes. Every example you can see above is working. And many other things
-are working. And almost _any_ thing which Wikipedia knows about, can be
-loaded through **Reality**, and somehow inspected and used and navigated
-to next entities and measured and ...
-
-Read more at ["How it works"](https://github.com/molybdenum-99/reality/wiki/How-it-works)
-page in our wiki. It's complicated, yet quite interesting.
-
-## Why/when do I need this?..
-
-* Demos and experiments;
-* Enrichement of existing data;
-* Teaching Ruby and data processing on realistic data...
-
-...and [more](https://github.com/molybdenum-99/reality/wiki/Applications).
-
-## Uhm, ok. How to use it?
-
-First, install the gem as usual (it is on rubygems, and named "reality"),
-using Gemfile/`bundle install` or `gem install reality`.
-
-Now, you can use it...
-
-### ...from your code
-
-```ruby
-require 'reality'
-
-th = Reality::Entity('Thailand')
-p th.area / th.population
-# => #<Reality::Measure(0.007 km²/person)>
-
-
-list = Reality::List('Terminator', 'Terminator 2', 'Terminator 3', 'Terminator 4', 'Terminator 5')
-# => #<Reality::List[Terminator?, Terminator 2?, Terminator 3?, Terminator 4?, Terminator 5?]>
-list.load!
-# => #<Reality::List[Terminator, Terminator 2: Judgment Day, Terminator 3: Rise of the Machines, Terminator Salvation, Terminator Genisys]>
-
-p list.map(&:published_at)
-# => [nil, #<Date: 1991-01-01>, #<Date: 2003-01-01>, #<Date: 2009-01-01>, #<Date: 2015-01-01>]
-```
-
-Start from [Getting started](https://github.com/molybdenum-99/reality/wiki/Getting-started)
-in our wiki and move along the pointers!
-
-### ...from command-line
-
-The `reality` command allows you to investigate various
-concepts in your terminal:
-
-```
-$ reality Katmandu
-----------------------------------
-#<Reality::Entity(Kathmandu):city>
-----------------------------------
-             area: #<Reality::Measure(49 km²)>
-            coord: #<Reality::Geo::Coord(27°43′0″N,85°22′0″E)>
-          country: #<Reality::Entity?(Nepal)>
-        elevation: #<Reality::Measure(1,400 m)>
-       located_in: #<Reality::Entity?(Nepal)>
-        long_name: "Kathmandu Metropolitan City\nKTM"
- official_website: "http://www.kathmandu.gov.np"
-       population: #<Reality::Measure(975,453 person)>
-        tz_offset: #<Reality::TZOffset(UTC+05:45)>
-
-
-$ reality Beatles albums first
-Please Please Me
-```
-
-See [wikipage](https://github.com/molybdenum-99/reality/wiki/Command-line-usage)
-for details.
-
-### ...from interactive console
-
-The `reality -i` command opens interactive console, allowing you to
-investigate Reality's features immediately. It also provides many useful
-shortcuts for less typing:
-
-```
-$ reality -i
-
-reality#1:001:0> b = E('Brno')
-# => #<Reality::Entity(Brno):city>
-reality#1:002:0> b.area
-# => #<Reality::Measure(230 km²)>
-reality#1:003:0> b.coord.weather
-# => #<Reality::Weather(10°C, Rain)>
-```
-
-...and so on. Read more at [Interactive console](https://github.com/molybdenum-99/reality/wiki/Interactive-console)
-and feel free to experiment!
-
-## Good. What next?..
-
-Reality currently in, let's say "working prototype" state. Many things
-work and useful, many others are subject to change/improve. Near and
-not-so-near plans looks like this (order is vague):
-
-* more definitions of useful Wikidata/Wikipedia properties and types,
-  cleanup and re-checking of existing ones;
-* more external datasources ([OpenStreetMap](http://www.openstreetmap.org/)
-  one of first candidates) and more info from already included ones;
-* more maturity: cleaner code, more tests, docs, config policy....
-* powerful and flexible data caching (if you run "study all world capitals"
-  script 10 times, or want to do a quick presentation of topic to students,
-  you'll be happy that previously quiried data are already on disk);
-* large demo-scripts set, maybe in independent repository;
-* separation of largely independent parts to another gems and libraries.
-
-## Docs
-
-* [Our wiki](https://github.com/molybdenum-99/reality/wiki) have pretty
-  comprehensive docs now, from Tutorial to some advanced topics;
-* [YARD docs](http://www.rubydoc.info/gems/reality) are mostly written
-  and contain explanations, examples and definitions.
-
-## Want to help?
-
-Great!
-
-**Reality** will be glad to accept your issues and pull requests.
-Currently, it would be great if somebody lay their hands on:
-
-* thoroughly define more and more Wikidata predicates (and enchance system
-  for predicates definition: consider aliases, plural/singular properties
-  and so on);
-* investigate and define more Wikipedia types (kinds of infoboxes) and
-  enchance existing ones;
-* connect more external services and integrate them into Reality (for
-  example, geocoding: via OpenStreetMap guess city from coordinates
-  **and** make this city a `Reality::Entity`);
-* play with Reality and share your experiences and examples and problems
-  and cool demos!
-
-[Contributing](https://github.com/molybdenum-99/reality/wiki/Contributing)
-page in wiki explains some things a bit deeper.
-
-## Compatibility
-
-Ruby 2+ is a must (we love refinements, keywords arguments and other
-cool stuff). JRuby & Rubinius compatibility was not checked still, help
-would be appreciated here!
-
-Note that there could be a problem with SSL sertificates while connecting
-to Wikipedia API. _TODO: explain the problem and point to recipes._
-  
 ## Credits
 
 * [Victor Shepelev](https://zverok.github.io) [@zverok](https://github.com/zverok);

data/lib/reality.rb

@@ -1,5 +1,14 @@
-require 'infoboxer'
 require 'yaml'
+require 'pp'
+require 'hashie'
+require 'fileutils'
+
+require 'backports/latest'
+require 'memoist'
+
+require 'money'
+require 'geo/coord'
+require 'tz_offset'
 
 # Reality is library for accessing all world data, starting from Wikipedia.
 #
@@ -16,24 +25,24 @@ module Reality
   end
 
   # basic functionality
-  require_ %w[version refinements config measure geo tz_offset]
-  require_ %w[util/parsers util/formatters]
+  require_ %w[version config measure tz_offset date coord currency]
+  require_ %w[setup util util/description util/refinements util/parsers util/formatters]
 
   # engines
-  require_ %w[infoboxer_templates wikidata]
-  Infoboxer.user_agent = "Reality/#{VERSION} (https://github.com/molybdenum-99/reality; zverok.offline@gmail.com)"
+  USER_AGENT = "Reality/#{VERSION} (https://github.com/molybdenum-99/reality; zverok.offline@gmail.com)"
 
   # entities
-  require_ %w[entity list]
-  require_ %w[definitions/*]
-  require_ %w[methods names]
-
-  include Methods
-  extend Methods
+  require_ %w[observation link query entity]
 
-  # extras
-  require_ %w[extras/open_weather_map extras/geonames extras/quandl]
-  include Extras::OpenWeatherMap
-  include Extras::Geonames
-  include Extras::Quandl
+  # particular describers
+  require_ %w[
+    describers
+    describers/abstract/base
+    describers/abstract/media_wiki
+    describers/wikipedia
+    describers/wikidata
+    describers/open_street_map
+    describers/wikimedia_commons
+    describers/open_weather_map
+  ]
 end

data/lib/reality/coord.rb

@@ -0,0 +1,27 @@
+module Reality
+  class Coord < Geo::Coord
+    def timezone
+      Util.require_optional('wheretz', 'Please install `wheretz` gem in order to have offline timezones')
+      WhereTZ.get(lat, lng)
+    end
+
+    def distance(other)
+      other = coerce_to_coord(other)
+      Reality::Measure['km'].new(super(other) / 1000.0)
+    end
+
+    private
+
+    def coerce_to_coord(val)
+      case val
+      when Geo::Coord
+        other
+      when Entity
+        (val['coordinates'] || val['coordinates location']) or
+          fail ArgumentError, "#{val} seem not hold any coordinates information"
+      else
+        fail ArgumentError, "#{val.class} can't be coerced to coordinates"
+      end
+    end
+  end
+end

data/lib/reality/currency.rb

@@ -0,0 +1,17 @@
+module Reality
+  class Currency < Money::Currency
+    module Methods
+      def rate_to(other)
+        Money.default_bank.get_rate(self, other)
+      end
+
+      def inspect
+        "#<Reality::Currency #{name} (#{symbol}, #{iso_code})>"
+      end
+    end
+    # Money::Currency have pretty tricky initializer
+    def self.new(id)
+      super(id).extend(Methods)
+    end
+  end
+end

data/lib/reality/date.rb

@@ -0,0 +1,9 @@
+require 'date'
+
+module Reality
+  class Date < ::Date
+    def inspect
+      '#<%s %s>' % [self.class.name, strftime('%Y-%m-%d')]
+    end
+  end
+end

data/lib/reality/describers.rb

@@ -0,0 +1,34 @@
+module Reality
+  class << self
+    extend Memoist
+
+    # FIXME: Or something ¯\_(ツ)_/¯
+    # Like proper "registering" themselves and blah blah
+    memoize def describers
+      {}
+    end
+
+    def wikipedia
+      describers['wikipedia']
+    end
+
+    def open_street_map
+      describers['openstreetmap']
+    end
+
+    alias openstreetmap open_street_map
+    alias osm open_street_map
+
+    def wikidata
+      describers['wikidata']
+    end
+
+    def commons
+      describers['wikimedia-commons']
+    end
+
+    def open_weather_map
+      describers['open_weather_map']
+    end
+  end
+end

data/lib/reality/describers/abstract/base.rb

@@ -0,0 +1,45 @@
+module Reality
+  module Describers
+    module Abstract
+      class Base
+        extend Memoist
+
+        def get(id)
+          # we assume that child was good and returned observations about only one entity, basically
+          observations_for(id).yield_self(&method(:make_entities)).first
+        end
+
+        def query(params)
+          Query.new(prefix, params)
+        end
+
+        memoize def log
+          Logger.new(STDOUT).tap { |l| l.level = Logger::INFO }
+        end
+
+        private
+
+        # To redefine in children
+        def descriptor
+          fail NotImplementedError
+        end
+
+        def observations_for(id)
+          fail NotImplementedError
+        end
+
+        # Internal helpers
+
+        def make_entities(observations)
+          observations.group_by(&:entity_uri).map { |_, group|
+            Entity.new(group)
+          }
+        end
+
+        def obs(entity_id, name, value, source: nil, time: nil)
+          Observation.new([prefix, entity_id].join('://'), name, value, time: time, source: source)
+        end
+      end
+    end
+  end
+end