phi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d24ffd5f95a41e7c888db90c75df8d576362222d
+  data.tar.gz: fcd9f3d45a1e7fbd0699ea6222a0402274be655c
+SHA512:
+  metadata.gz: e003baf998d98f451f274f2191c6167a5481e7325934f0c9144ba981ef4d23d479f95f74c3cf5a50062c9df1c840335de380ca6902caefffe20fc2d9a19c1955
+  data.tar.gz: 21b169024c559bae6a0afec6d4600e4038b7374790c674a2508be170018ec62060759ea717d05cce2893f9429099a9830c3f07ab4b68d8864628ec158276dd03

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 lwangenheim
+
+MIT License
+
+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

@@ -0,0 +1,30 @@
+# Phi
+
+TODO: Write a gem description
+Note: The Philosophy Index of Philosophy is zero.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'phi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/phi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/phi

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'phi/cli'
+
+Phi::Cli.run

data/lib/phi/cli.rb

@@ -0,0 +1,20 @@
+require 'phi'
+
+module Phi
+  module Cli
+    extend self
+
+    def term
+      ARGV.fetch(0) { 
+        puts 'Must provide term to phi command. Usage: `phi term`' 
+        exit 1
+      }
+    end
+
+    def run
+      i = Phi::Losophy.new(term).index
+      puts "The Philosophy Index of #{term} is #{i}."
+    end
+
+  end
+end

data/lib/phi/losophy/page/node.rb

@@ -0,0 +1,38 @@
+module Phi
+  class Losophy
+    class Page
+      class Node
+        attr_reader :parent
+        attr_accessor :in_parentheses
+
+        def initialize(parent)
+          @parent = parent
+        end
+
+        def anchor
+          parent.children.each do |child|
+            if child.name == 'text'
+              text(child)
+            elsif child.name == 'a' && out_of_parentheses?
+              return child
+            end
+          end
+        end
+
+        def text(node)
+          node.text.split('').each { |c|
+            if c == '('
+              self.in_parentheses = true
+            elsif c == ')'
+              self.in_parentheses = false
+            end
+          }
+        end
+
+        def out_of_parentheses?
+          !in_parentheses
+        end
+      end
+    end
+  end
+end

data/lib/phi/losophy/page.rb

@@ -0,0 +1,53 @@
+module Phi
+  class Losophy
+    class Page
+      
+      attr_reader :term, :connection
+      
+      def initialize(term, connection)
+        @term       = term
+        @connection = connection
+      end
+
+      def philosophy?
+        term.downcase == "philosophy"
+      end
+
+      def next
+        @next ||= Page.new(next_term, connection)
+      end
+
+      def inspect
+        "#<#{self.class.name}:#{term}>"
+      end
+
+      private
+
+      def next_term
+        Node.new(html.css(selector)).anchor.attr("href")[6..-1]
+      end
+
+      def selector
+        %q{#mw-content-text > p:first}# > a:first[href^='/wiki']}
+      end
+
+      def html
+        @html ||= Nokogiri::HTML(page)
+      end
+
+      def page
+        @page ||= request.body
+      end
+
+      def request
+        sleep 0.25 
+        connection.get(path: path)
+      end
+
+      def path
+        "/wiki/#{term}"
+      end
+
+    end
+  end
+end

data/lib/phi/losophy/pages.rb

@@ -0,0 +1,49 @@
+module Phi
+  class Losophy
+    class Pages
+      include Enumerable 
+      extend Forwardable
+      
+      attr_reader :losophy, :pages
+
+      def initialize(losophy)
+        @losophy = losophy
+        @pages   = []
+      end
+
+      def each 
+        until current_page.philosophy?
+          guard_max_pages!
+          yield self.next 
+        end
+      end
+
+      def current_page
+        @current_page || self.current_page = first_page
+      end
+
+      def next
+        self.current_page = current_page.next
+      end
+
+      private
+ 
+      def_delegators :losophy, :term, :connection
+
+      def first_page
+        @first_page ||= Page.new(term, connection)          
+      end
+
+      def current_page=(page)
+        pages << @current_page = page
+      end
+
+      def guard_max_pages!
+        return if pages.count <= Phi.max
+        raise MaximumPages.new("max pages (#{pages.count}) have been crawled")
+      end
+
+      MaximumPages = Class.new(StandardError)
+    end
+  end
+end

data/lib/phi/losophy.rb

@@ -0,0 +1,29 @@
+module Phi
+  class Losophy
+
+    WIKI_URL = "http://en.wikipedia.org"
+
+    attr_reader :term
+
+    def initialize(term)
+      @term = term     
+    end
+
+    def index
+      pages.count
+    end
+    
+    def inspect
+      "#<#{self.class.name}:#{term}>"
+    end
+
+    def pages
+      @pages ||= Pages.new(self)
+    end
+
+    def connection
+      @connection ||= Excon.new(WIKI_URL, middlewares: Excon.defaults[:middlewares] + [Excon::Middleware::RedirectFollower])
+    end
+
+  end
+end

data/lib/phi/version.rb

@@ -0,0 +1,3 @@
+module Phi
+  VERSION = "1.0.0"
+end

data/lib/phi.rb

@@ -0,0 +1,14 @@
+require 'excon'
+require 'nokogiri'
+
+module Phi
+  def self.max
+    50
+  end
+end
+
+require 'phi/losophy'
+require 'phi/losophy/page'
+require 'phi/losophy/page/node'
+require 'phi/losophy/pages'
+require 'phi/version'

data/phi.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "phi"
+  spec.version       = Phi::VERSION
+  spec.authors       = ["Lee Wangenheim", "Rebecca Hunter", "Adam Hunter"]
+  spec.email         = ["lwangenheim@gmail.com", "hrmrebecca@gmail.com", "adamhunter@me.com"]
+  spec.summary       = %q{Command line function to output the Philosophy Index of a Wikipedia article.}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "excon", "~> 0.32"
+  spec.add_dependency "nokogiri", "~> 1.6.1"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/phi/losophy/pages_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Phi::Losophy::Pages do
+  it "includes Enumerable" do 
+    expect(described_class.ancestors).to include Enumerable
+  end
+end

data/spec/phi/losophy_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Phi::Losophy do
+  let(:term) { "hyperlink" } 
+  let(:instance) { described_class.new(term) }
+
+  it "can calculate the index of 'philosophy'" do 
+    expect(described_class.new("philosophy").index).to eq 0
+  end
+
+  it "can calculate the index" do 
+    expect(instance.index).to eq 19
+  end
+
+  it "injects the term correctly" do 
+    expect(instance.term).to eq term 
+  end
+
+  it "looks fancy when inspected" do 
+    expect(instance.inspect).to eq "#<Phi::Losophy:#{term}>"
+  end
+
+  it "has pages" do 
+    expect(instance.pages).to be_a Phi::Losophy::Pages
+  end
+
+  it "has a connection" do 
+    expect(instance.connection).to be_an Excon::Connection
+  end
+end

data/spec/phi_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Phi do
+  it "is a Module" do 
+    expect(Phi).to be_a Module
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'phi'
+require 'pry'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: phi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lee Wangenheim
+- Rebecca Hunter
+- Adam Hunter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.32'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.32'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- lwangenheim@gmail.com
+- hrmrebecca@gmail.com
+- adamhunter@me.com
+executables:
+- phi
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/phi
+- lib/phi.rb
+- lib/phi/cli.rb
+- lib/phi/losophy.rb
+- lib/phi/losophy/page.rb
+- lib/phi/losophy/page/node.rb
+- lib/phi/losophy/pages.rb
+- lib/phi/version.rb
+- phi.gemspec
+- spec/phi/losophy/pages_spec.rb
+- spec/phi/losophy_spec.rb
+- spec/phi_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Command line function to output the Philosophy Index of a Wikipedia article.
+test_files:
+- spec/phi/losophy/pages_spec.rb
+- spec/phi/losophy_spec.rb
+- spec/phi_spec.rb
+- spec/spec_helper.rb