landmarks-of-st-petersburg 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fe69baa2c65023398a291135a8a53600f7e3075
-  data.tar.gz: 6154934acb24c6a64acb2da3e579dfc4ea0eb503
+  metadata.gz: 8046157cd1eaa5e53b9972ab18620266673e956c
+  data.tar.gz: 9dc7a608f28dc0941604c82a76a4b1c4f99e62d2
 SHA512:
-  metadata.gz: bd03b63df1d031f60f177ad4af3686d73c4d5d4373cea97144519d8fe7db293ae332fb51f58dd6735aa23ed68e06fdfacb6984231bdc31d0552cc15fd5d18bcf
-  data.tar.gz: 529a34075963a8ee57cb14514932869be99d90b6f4cb5dd16185aad8d61187503ada5a9c327d427f2b3aa1c1dd36cb63d4a56549283378c7956996ff50fb2a87
+  metadata.gz: 5b84f215ee90313765c8b79ec1483d484ce34e71a792d89791d0755abbfc7d669e347c6e3d0a76562c0fee6eb184c89627efc51bd844aad23809364444f16392
+  data.tar.gz: 44b1d9a87a2219a6933bab41633c6ae8539dfbf0edb09c8dafbde6e0aa98682109b0ed86bb913e871dba0e22c262c8edc40f7e917d957a62c95b20c531350a46

data/lib/landmarks/version.rb

@@ -1,3 +1,3 @@
 module Landmarks
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: landmarks-of-st-petersburg
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - "'Igor Eskin'"
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2017-07-29 00:00:00.000000000 Z
 dependencies:
@@ -38,34 +38,38 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   This gem allows to scrape a website of top 20 architectural attractions of St. Petersburg, Russia,
       and by the user's choice display an eloquent description of each individual attraction as well as some useful details (if available),
       such as location, directions, names of other attractions located nearby, business hours and possible admission fee.
 email:
 - "'eskinhd@gmail.com'"
-executables: []
+executables:
+- landmarks
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
 - bin/landmarks
-- bin/setup
 - config/environment.rb
-- landmarks-of-st-petersburg-0.1.0.gem
-- landmarks.gemspec
 - lib/landmarks.rb
 - lib/landmarks/cli.rb
 - lib/landmarks/landmark.rb
 - lib/landmarks/scraper.rb
 - lib/landmarks/version.rb
-- spec.md
 homepage: https://github.com/igoreskin/landmarks-of-st-petersburg-cli-app
 licenses:
 - MIT

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-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.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at 'eskinhd@gmail.com'. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'pry'
-gem 'require_all'
-gem 'nokogiri'
-
-# Specify your gem's dependencies in landmarks.gemspec
-gemspec

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 'Igor Eskin'
-
-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.md

@@ -1,39 +0,0 @@
-# Landmarks of St. Petersburg
-
-This Ruby Gem provides a CLI to view the top 20 architectural landmarks of St. Petersburg with detailed description and other useful information.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'landmarks-of-st-petersburg'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install landmarks-of-st-petersburg
-
-## Usage
-
-To run this gem as a local application, please run ./bin/landmarks from the command line.
-If you have already installed the gem, please enter landmarks in the command line and follow the on-screen prompts.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/igoreskin/landmarks-of-st-petersburg-cli-app. 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.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "landmarks"
-
-
-# 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(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/landmarks.gemspec

@@ -1,39 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'landmarks/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "landmarks-of-st-petersburg"
-  spec.version       = Landmarks::VERSION
-  spec.authors       = ["'Igor Eskin'"]
-  spec.email         = ["'eskinhd@gmail.com'"]
-
-  spec.summary       = %q{Top 20 architectural landmarks of St. Petersburg with descriptions and other useful information.}
-  spec.description   = %q{This gem allows to scrape a website of top 20 architectural attractions of St. Petersburg, Russia,
-    and by the user's choice display an eloquent description of each individual attraction as well as some useful details (if available),
-    such as location, directions, names of other attractions located nearby, business hours and possible admission fee.}
-  spec.homepage      = "https://github.com/igoreskin/landmarks-of-st-petersburg-cli-app"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-=begin
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-=end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-end

data/spec.md

@@ -1,44 +0,0 @@
-# Specifications for the CLI Assessment
-
-Specs:
-
-- [x] Have a CLI for interfacing with the application
-
-The CLI interfaces with the application by interacting with the Landmarks::Landmark class, whereas
-all the logic of the interaction between the Landmarks::Landmark class and Landmarks::Scraper class
-is fully encapsulated in the instance and class methods of the Landmarks::Landmark class. First the CLI
-assigns a property of the Landmark class called scraper (which is essentially a newly instantiated
-object of the Scraper class, and we only need one object of this class) to a variable called scraper,
-which then allows us to call an instance method of the Scraper class directly on this variable and to
-scrape and print a numbered list of all our landmarks. After that, inside of the #start method defined
-below, which contains the entire logic of the interaction between the program and the user, the CLI
-is then calling reader instance methods of the Landmark class to display landmarks' properties at the user's
-request. This design actually allows us to adhere to the principle of single responsibility in terms of
-the CLI only interacting with the Landmark class - even the one and only object of the Scraper class is,
-from the point of view of the CLI, just a property of the Landmark class.
-
-- [x] Pull data from an external source
-
-The first instance method in the Landmarks::Scraper class called #get_page returns the contents of the website
-we are scraping in the form of a set of nested nodes. The following method in the same class called #scrape_landmarks_index
-iterates through the return value of the previous method, instantiates new objects of the Landmarks::Landmark class
-and uses the appropriate CSS selectors to scrape the data, which is then assigned to these objects as their properties.
-It is worth noting that the principle of single responsibility is being adhered to here as well, since each method
-in the Scraper class is on responsible for a single clearly defined action.
-
-- [x] Implement both list and detail views
-
-The logic of implementation of the list view is contained inside of the method called #call in the CLI class, where
-the #print_the_title method is called on the scraper variable, which, being a property of the Landmark class,
-actually is a newly instantiated object of the Scraper class assigned to the Landmark class as its property
-in the form of a class variable and a reader method. The next method, #print_landmarks_index, is also called on the
-same variable to print the numbered list of the landmarks. Although both #print_the_title and #print_landmarks_index
-methods are instance methods of the Scraper class, from the point of view of the CLI they are called on the variable
-representing a property of the Landmark class.
-
-The detailed view of each landmark is implemented through two instance methods of the Landmark class, #description
-(which provides a detailed description of the landmark selected by the user) and, if the user chooses so, #directions
-(which in turn displays some useful information about the landmark, such as directions, business hours, possible
-admission fees etc., if available). The entire logic of this process is encapsulated in the #start method of the CLI
-class. The #start method then calls itself twice (if, after displaying either the description or the details of the
-selected landmark, the user wishes to find out more about another landmark), and is therefore recursive.