humans_rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23eb23b10bd8b468d79895cc4d10366847413d93
+  data.tar.gz: 03a17e007a29bb8643a2e32340dd24bf5128cc17
+SHA512:
+  metadata.gz: 909d80dac1b89cd2889c122d245be9dfa7324127c878c9012d6f2549e5b2d164b42504499ed38b0ccf4681a06c50dee10b7f7cf3d2824eaa6db6024a2b8f3c32
+  data.tar.gz: cf2101978234a73850f2b93ada1d165a5816f7e821603abbf15cd0194773ec740f55025106c0d2baab1cfb88db1d38b2faf2608ae1331b6d9c944e82496b9b1a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+langauage: ruby
+script: "script/cibuild"
+sudo: false
+cache: bundler

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Balter
+
+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,35 @@
+# Humans.rb
+
+A Ruby gem for parsing humans.txt files
+
+[![Build Status](https://travis-ci.org/benbalter/humans.rb.svg)](https://travis-ci.org/benbalter/humans.rb)
+
+## Installation
+
+1. Add `gem 'humans-rb'` to your project's Gemfile
+2. `bundle install`
+
+## Usage
+
+```ruby
+# Passing a domain (defaults to domain/humans.txt)
+> HumansRb.new("http://ben.balter.com").parse
+=> {
+    :site=> {
+      :"last updated"=>"2015/03/12",
+      :standards=>"HTML5, CSS3",
+      :components=> "jekyll, jekyll-coffeescript, jekyll-sass-converter, kramdown, maruku, rdiscount, redcarpet, RedCloth, liquid, pygments.rb, jemoji, jekyll-mentions, jekyll-redirect-from, jekyll-sitemap, github-pages, ruby"
+    },
+    :team=> {
+      :name=>"benbalter", :site=>"https://github.com/benbalter"},
+      :name=>"balterbot", :site=>"https://github.com/balterbot"}
+    }
+  }
+
+# Passing a URL
+> HumansRb.new("http://ben.balter.com/humans.txt").parse
+=> {:site=>..}
+
+# Passing a string
+> HumansRb.new("/* SITE */...").parse
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["--order", "rand", "--color"]
+end

data/humans_rb.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'humans/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "humans_rb"
+  spec.version       = HumansRb::VERSION
+  spec.authors       = ["Ben Balter"]
+  spec.email         = ["ben.balter@github.com"]
+  spec.summary       = %q{A Ruby gem for parsing humans.txt files}
+  spec.homepage      = "https://github.com/benbalter/humans.rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "typhoeus", "~> 0.7"
+  spec.add_dependency "parslet", "~> 1.6"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+
+end

data/lib/humans/parser.rb

@@ -0,0 +1,31 @@
+class HumansRb::Parser < Parslet::Parser
+    rule(:space)       { str(" ") }
+    rule(:space?)      { space.repeat }
+    rule(:tab)         { match("[\t]").repeat(1) }
+    rule(:tab?)        { match("[\t]").repeat }
+    rule(:whitespace)  { (space | tab).repeat(1) }
+    rule(:whitespace?) { (space | tab).repeat }
+
+    rule(:newline)  { match("[\n]") >> whitespace? }
+    rule(:newline?) { newline.maybe }
+
+    rule(:slash_star) { str("/*") }
+    rule(:star_slash) { str("*/") }
+    rule(:heading_name) { newline.absent? >> space.absent? >> match("[A-Z]").repeat(1) }
+    rule(:heading) { slash_star >> space >> heading_name.as(:heading) >> space >> star_slash >> newline }
+
+    rule(:colon) { str(":") }
+    rule(:key) { slash_star.absent? >> newline.absent? >> match("[^:\n]").repeat.as(:key) >> colon }
+    rule(:value) { newline.absent? >> match("[^\n]").repeat.as(:value) }
+    rule(:key_value_pair) { whitespace? >> key >> space >> value >> newline }
+    rule(:key_value_pairs) { key_value_pair.repeat(1).as(:values) }
+
+    rule(:name) { slash_star.absent? >> match("[^\t\n:]").repeat(1).as(:name) >> newline }
+    rule(:team_member) { whitespace? >> name.maybe >> key_value_pair.repeat(1) >> newline? >> newline? }
+    rule(:team_members) { team_member.as(:member).repeat(2).as(:members) }
+
+    rule(:section) { heading >> newline? >> (team_members | key_value_pairs) >> newline? }
+    rule(:document) { section.repeat(1).as(:sections) }
+
+    root :document
+end

data/lib/humans/transform.rb

@@ -0,0 +1,23 @@
+class HumansRb
+  class Transform < Parslet::Transform
+    rule(:sections => subtree(:sections)) do |dict|
+      dict[:sections].reduce(Hash.new, :merge)
+    end
+    
+    rule(:heading => simple(:heading), :values => subtree(:values)) do |dict|
+      { dict[:heading].to_s.downcase.to_sym => dict[:values].reduce(Hash.new, :merge) }
+    end
+
+    rule(:heading => simple(:heading), :members => subtree(:values)) do |dict|
+      { dict[:heading].to_s.downcase.to_sym => dict[:values] }
+    end
+
+    rule(:member => subtree(:member)) do |dict|
+      dict[:member].reduce(Hash.new, :merge)
+    end
+
+    rule(:key => simple(:key), :value => subtree(:value)) do
+      { key.to_s.downcase.to_sym => value.to_s }
+    end
+  end
+end

data/lib/humans/version.rb

@@ -0,0 +1,3 @@
+class HumansRb
+  VERSION = "0.0.1"
+end

data/lib/humans.rb

@@ -0,0 +1,26 @@
+require 'typhoeus'
+require 'parslet'
+require "humans/version"
+require "humans/parser"
+require "humans/transform"
+
+class HumansRb
+  def initialize(url_or_string)
+    @url_or_string = url_or_string
+  end
+
+  def body
+    if @url_or_string =~ /^http/
+      @url_or_string << "/humans.txt" if !(@url_or_string =~ /humans\.txt$/)
+      @url_or_string = Typhoeus.get(@url_or_string, accept_encoding: "gzip").body
+    else
+      @url_or_string
+    end
+  end
+
+  def parse
+    Transform.new.apply(Parser.new.parse(body))
+  rescue Parslet::ParseFailed => failure
+    puts failure.cause.ascii_tree
+  end
+end

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle install

data/script/cibuild

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+bundle exec rake spec
+gem build humans_rb.gemspec

data/script/console

@@ -0,0 +1,3 @@
+#! /bin/sh
+
+bundle exec pry -r ./lib/humans.rb

data/script/release

@@ -0,0 +1,38 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf humans_rb-*.gem
+gem build -q humans_rb.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls humans_rb-*.gem | sed 's/^humans_rb-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push humans_rb-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/spec/fixtures/humans.txt

@@ -0,0 +1,12 @@
+/* SITE */
+Last Updated: 2015/03/12
+Standards: HTML5, CSS3
+Components: jekyll, jekyll-coffeescript, jekyll-sass-converter, kramdown, maruku, rdiscount, redcarpet, RedCloth, liquid, pygments.rb, jemoji, jekyll-mentions, jekyll-redirect-from, jekyll-sitemap, github-pages, ruby
+
+/* TEAM */
+
+Name: benbalter
+Site: https://github.com/benbalter
+
+Name: balterbot
+Site: https://github.com/balterbot

data/spec/humans_parser_spec.rb

@@ -0,0 +1,199 @@
+require "spec_helper"
+
+describe HumansRb::Parser do
+  let(:parser) { HumansRb::Parser.new }
+
+  context "spaces" do
+    let(:space_parser) { parser.space }
+    it "can detect a space" do
+      expect(space_parser).to parse(" ")
+      expect(space_parser).to_not parse("\n")
+    end
+  end
+
+  context "newlines" do
+    let(:newline_parser) { parser.newline }
+    it "can detect a new line" do
+      expect(newline_parser).to parse("\n")
+      expect(newline_parser).to_not parse(" ")
+    end
+  end
+
+  context "stars" do
+    let(:star_slash_parser) { parser.star_slash }
+    let(:slash_star_parser) { parser.slash_star }
+
+    it "can detect a star slash" do
+      expect(star_slash_parser).to parse("*/")
+    end
+
+    it "can detect a slash star" do
+      expect(slash_star_parser).to parse("/*")
+    end
+  end
+
+  context "heading parsing" do
+    let(:heading_parser) { parser.heading }
+    let(:heading_name_parser) { parser.heading_name }
+
+    it "parses the heading name" do
+      expect(heading_name_parser).to parse("TEST")
+      expect(heading_name_parser).to_not parse("TEST TEST")
+    end
+
+    it "parses headings" do
+      expect(heading_parser).to parse("/* TEST */\n")
+    end
+  end
+
+  context "key/value parsing" do
+    let(:key_value_parser) { parser.key_value_pair }
+    let(:colon_parser) { parser.colon }
+    let(:key_parser) { parser.key }
+    let(:value_parser) { parser.value }
+
+    it "detects colons" do
+      expect(colon_parser).to parse(":")
+    end
+
+    it "detects keys" do
+      expect(key_parser).to parse("foo:")
+      expect(key_parser).to parse("foo bar:")
+      expect(key_parser).to_not parse("foo:\n")
+      expect(key_parser).to_not parse("foo: ")
+    end
+
+    it "detects values" do
+      expect(value_parser).to parse("foo bar")
+      expect(value_parser).to_not parse("foo \nbar")
+    end
+
+    it "parses key/value pairs" do
+      expect(key_value_parser).to parse("foo: bar\n")
+      expect(key_value_parser).to parse("foo: bar\n")
+      expect(key_value_parser).to parse("foo foo: bar\n")
+    end
+
+    it "parses key value pairs with leading whitespace" do
+      expect(key_value_parser).to parse("  foo: bar\n")
+      expect(key_value_parser).to parse("\tfoo: bar\n")
+    end
+  end
+
+  context "teams" do
+    let(:name_parser) { parser.name }
+    let(:team_member_parser) { parser.team_member }
+    let(:team_members_parser) { parser.team_members }
+
+    it "detects a team member" do
+      expect(team_member_parser).to parse("key: value\nkey2: value2\n\n")
+    end
+
+    it "detects GitHub-style names" do
+      expect(name_parser).to parse("Ben Balter\n")
+    end
+
+    it "detects Github-style team members" do
+      input = <<-text
+  Jesse Newland
+  Site: https://github.com/jnewland
+  Location: San Francisco, CA
+
+      text
+      expect(team_member_parser).to parse(input)
+    end
+
+    it "detects teams" do
+      input = <<-text
+Name: benbalter
+Site: https://github.com/benbalter
+
+Name: balterbot
+Site: https://github.com/balterbot
+      text
+      expect(team_members_parser).to parse(input)
+    end
+
+    it "detects GitHub-style humans.txt teams" do
+      input = <<-text
+  Jesse Newland
+  Site: https://github.com/jnewland
+  Location: San Francisco, CA
+
+  Justin Palmer
+  Site: https://github.com/Caged
+  Location: Portland, OR
+
+  Sonya Green
+  Site: https://github.com/sundaykofax
+
+
+  Lee Reilly
+  Site: https://github.com/leereilly
+  Location: San Francisco, CA
+      text
+      expect(team_members_parser).to parse(input)
+    end
+  end
+
+  context "section parsing" do
+    let(:section_parser) { parser.section }
+
+    it "parses sctions" do
+      expect(section_parser).to parse("/* TEST */\nkey: value\n")
+      expect(section_parser).to parse("/* TEST */\n\nkey: value\n")
+    end
+
+    it "parses sctions with tabs" do
+      expect(section_parser).to parse("/* TEST */\n\tkey: value\n")
+      expect(section_parser).to parse("/* TEST */\n\n\tkey: value\n")
+    end
+
+    it "should parse a TEAM section" do
+      input = <<-text
+/* TEAM */
+Name: benbalter
+Site: https://github.com/benbalter
+
+Name: balterbot
+Site: https://github.com/balterbot
+      text
+      expect(section_parser).to parse(input)
+    end
+  end
+
+  context "document" do
+    let(:document_parser) { parser.document }
+
+    it "parses multiple sections" do
+      input = <<-text
+/* SITE */
+Last Updated: 2015/03/12
+Standards: HTML5, CSS3
+
+/* TEAM */
+Name: benbalter
+Site: https://github.com/benbalter
+
+      text
+      expect(document_parser).to parse(input)
+    end
+
+    it "should parse ben.balter.com's humans.txt" do
+      input = <<-text
+/* SITE */
+Last Updated: 2015/03/12
+Standards: HTML5, CSS3
+
+/* TEAM */
+
+Name: benbalter
+Site: https://github.com/benbalter
+
+Name: balterbot
+Site: https://github.com/balterbot
+      text
+      expect(document_parser).to parse(input)
+    end
+  end
+end

data/spec/humans_rb_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe "humans.rb" do
+
+  before do
+    @humans = HumansRb.new load_fixture("humans.txt")
+  end
+
+  it "should return the string if passed" do
+    expect(HumansRb.new("foo").body).to eql("foo")
+  end
+
+  it "should return the body if a URL is passed" do
+    stub_request(:get, "http://ben.balter.com/humans.txt").
+      to_return(:status => 200, :body => "foo", :headers => {})
+
+    expect(HumansRb.new("http://ben.balter.com/humans.txt").body).to eql("foo")
+  end
+
+  it "should return headings" do
+    output = @humans.parse
+    expect(output.count).to eql(2)
+  end
+end

data/spec/humans_transform_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe HumansRb::Transform do
+  let(:xform) { HumansRb::Transform.new }
+
+  context "values" do
+    it "transform the key/value pair values" do
+      expected = { :foo => "bar" }
+      expect(xform.apply({ :key => "foo", :value => "bar" })).to eq(expected)
+    end
+
+    it "merges the array of hashes into a single hash" do
+      input = { :heading => "test", :values => [{ :foo => "bar"}, {:foo2 => "bar2" }] }
+      expected = { :foo => "bar", :foo2 => "bar2" }
+      expect(xform.apply(input)[:test]).to eq(expected)
+    end
+  end
+
+  context "headings" do
+    it "converts the heading" do
+      input = { :heading => "test", :values => [{ :foo => "bar"}, {:foo2 => "bar2" }] }
+      expect(xform.apply(input).keys.first).to eq(:test)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "bundler/setup"
+require "parslet/rig/rspec"
+
+ENV['RACK_ENV'] = 'test'
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'webmock/rspec'
+
+require_relative "../lib/humans"
+
+WebMock.disable_net_connect!
+
+def fixtures_dir
+  File.expand_path("./fixtures", File.dirname(__FILE__))
+end
+
+def load_fixture(fixture)
+  path = File.expand_path(fixture, fixtures_dir)
+  File.open(path).read
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: humans_rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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:
+- ben.balter@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- humans_rb.gemspec
+- lib/humans.rb
+- lib/humans/parser.rb
+- lib/humans/transform.rb
+- lib/humans/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- spec/fixtures/humans.txt
+- spec/humans_parser_spec.rb
+- spec/humans_rb_spec.rb
+- spec/humans_transform_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/benbalter/humans.rb
+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: A Ruby gem for parsing humans.txt files
+test_files:
+- spec/fixtures/humans.txt
+- spec/humans_parser_spec.rb
+- spec/humans_rb_spec.rb
+- spec/humans_transform_spec.rb
+- spec/spec_helper.rb