sydney 0.0.1

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Geoff Harcourt
+
+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,29 @@
+# Sydney
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sydney'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sydney
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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/lib/sydney.rb

@@ -0,0 +1,32 @@
+require "sydney/version"
+
+require "treetop"
+
+module Sydney
+
+  # Load the Treetop grammar from the 'sexp_parser' file, and
+  # create a new instance of that parser as a class variable
+  # so we don't have to re-create it every time we need to
+  # parse a string
+  Treetop.load(File.join(
+          File.dirname(__FILE__),
+          "/sydney/sydney_alias_file/grammar_rules.treetop")
+  )
+  @@parser = SydneyAliasFileParser.new
+
+  def self.parse(data)
+    # Pass the data over to the parser instance
+    tree = @@parser.parse(data)
+
+    # If the AST is nil then there was an error during parsing
+    # we need to report a simple error message to help the user
+    if(tree.nil?)
+      raise Exception, "Parse error at offset: #{@@parser.index}"
+    end
+
+    return tree
+  end
+
+end
+
+require 'sydney/sydney_alias_file/node_extensions'

data/lib/sydney/sydney_alias_file/grammar_rules.treetop

@@ -0,0 +1,49 @@
+grammar SydneyAliasFile
+  rule document
+    section* <Document>
+  end
+
+  rule section
+    leading_whitespace:whitespace section_title:section_comment* content:alias_entry+ <Section>
+  end
+
+  rule section_comment
+    comment_code:comment_leader 2.. content:line <SectionComment>
+  end
+
+  rule alias_entry
+    entry_comments:alias_comment* definition:alias_definition <AliasEntry>
+  end
+
+  rule alias_comment
+    leading:comment_leader !comment_leader comment_text:line <AliasComment>
+  end
+
+  rule alias_definition
+    leading:'alias ' prefix:[A-Za-z\-\s\.]+ equal_sign:[\s]* '=' [\s]* aliased_command:text end_of_line:newline* <AliasDefinition>
+  end
+
+  rule quote_character
+    [\'\"]
+  end
+
+  rule line
+    content:text trailer:newline*
+  end
+
+  rule comment_leader
+    '#'
+  end
+
+  rule whitespace
+    [\s\n]*
+  end
+
+  rule text
+    [^\n]+
+  end
+
+  rule newline
+    [\n]+
+  end
+end

data/lib/sydney/sydney_alias_file/node_extensions.rb

@@ -0,0 +1,65 @@
+ module SydneyAliasFile
+  class SyntaxNode < Treetop::Runtime::SyntaxNode
+    def to_s
+      text_value
+    end
+  end
+
+  class Document < SyntaxNode
+    def sections
+      to_a
+    end
+
+    def to_a
+      elements.map{ |element| element }
+    end
+  end
+
+  class Section < SyntaxNode
+    def title
+      section_title.elements.map(&:to_s).join(' ')
+    end
+
+    def entries
+      content.elements
+    end
+  end
+
+  class SectionComment < SyntaxNode
+    def to_s
+      content.text_value.strip
+    end
+  end
+
+  class AliasEntry < SyntaxNode
+    def comments
+      entry_comments.elements
+    end
+
+    def comment
+      comments.map(&:to_s).join(' ')
+    end
+
+    def alias
+      definition
+    end
+  end
+
+  class AliasComment < SyntaxNode
+    def to_s
+      comment_text.text_value.strip
+    end
+  end
+
+  class AliasDefinition < SyntaxNode
+    def shortcut
+      prefix.text_value.strip
+    end
+
+    def command
+      stripped_command = aliased_command.to_s.strip
+      stripped_command[1,stripped_command.length - 2]
+    end
+  end
+
+end

data/lib/sydney/version.rb

@@ -0,0 +1,3 @@
+module Sydney
+  VERSION = "0.0.1"
+end

data/spec/fixtures/aliases

@@ -0,0 +1,39 @@
+
+alias noop='noop -all'
+## Unix 
+## Command Line Aliases
+# Continuously tail file live.
+# This can be useful when tracking activity.
+alias tlf="tail -f"
+alias ln='ln -v'
+alias mkdir='mkdir -p'
+alias ...='../..'
+alias l='ls'
+alias ll='ls -al'
+alias lh='ls -Alh'
+
+# Pipe to grep
+alias -g G='| grep'
+# Pipe to less
+alias -g M='| less'
+# Line count
+alias -g L='| wc -l'
+alias -g ONE="| awk '{ print \$1}'"
+
+## Git
+alias g="git"
+alias gci="git pull --rebase && rake && git push"
+
+## Bundler
+alias b="bundle"
+
+## Tests and Specs
+alias t="ruby -I test"
+alias cuc="bundle exec cucumber"
+
+## Rubygems
+alias gi="gem install"
+alias giv="gem install -v"
+
+## Rails
+alias migrate="rake db:migrate && rake db:rollback && rake db:migrate && rake db:test:prepare"

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'sydney'
+
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.before(:all) do
+    @alias_file = IO.readlines('spec/fixtures/aliases').join
+    @parser_result = Sydney.parse(@alias_file)
+  end
+
+end

data/spec/sydney_alias_file/alias_comment_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe SydneyAliasFile::AliasComment do
+
+  context "when the alias has a comment" do
+    before(:all) do
+      @comment = @parser_result.sections[1].entries.first.comment
+    end
+
+    describe "#to_s", :focus do
+      it "returns the comment text" do
+        @comment.to_s.should match(/Continuously tail file live\. This can be useful when tracking activity./)
+      end
+
+      it "trims the comment character from the front" do
+        @comment.to_s[0,1].should_not include(' ')
+      end
+
+      it "trims leading and trailing whitespace and newlines" do
+        @comment.to_s[0,2].should_not include(' ')
+        @comment.to_s[-3,3].should_not include(' ')
+        @comment.to_s.should_not match(/\n/)
+      end
+    end
+  end
+
+  context "when the alias does not have a comment" do
+    it "returns an empty string" do
+      @parser_result.sections.first.entries.first.comment.should eq('')
+    end
+  end
+end

data/spec/sydney_alias_file/alias_definition_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe SydneyAliasFile::AliasDefinition do
+  before(:all) do
+    @alias_definition = @parser_result.sections[1].entries.first.alias
+  end
+
+  describe "#shortcut" do
+    it "returns the alias to use at the command line with no leading or trailing whitespace" do
+      @alias_definition.shortcut.should eq('tlf')
+    end
+  end
+
+  describe "#command" do
+    it "returns the command to be aliased by the shortcut" do
+      @alias_definition.command.should eq('tail -f')
+    end
+  end
+end

data/spec/sydney_alias_file/alias_entry_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe SydneyAliasFile::AliasEntry do
+  before(:all) do
+    @alias_entry = @parser_result.sections[1].entries.first
+  end
+
+  describe '#comments' do
+    it "returns an array of all the AliasComment nodes" do
+      @alias_entry.comments.count.should eq(2)
+      @alias_entry.comments.first.class.should eq(SydneyAliasFile::AliasComment)
+    end
+  end
+
+  describe '#comment' do
+    it "returns a string with all the comments joined by a space" do
+      @alias_entry.comment.class.should eq(String)
+      @alias_entry.comment.should eq('Continuously tail file live. This can be useful when tracking activity.')
+    end
+  end
+
+  describe '#alias' do
+    it "returns an AliasDefinition node" do
+      @alias_entry.alias.class.should eq(SydneyAliasFile::AliasDefinition)
+    end
+  end
+end

data/spec/sydney_alias_file/document_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe SydneyAliasFile::Document do
+  describe "sections" do
+    it "divides the document into sections" do
+      @parser_result.sections.count.should eq(7)
+    end
+  end
+end

data/spec/sydney_alias_file/section_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe SydneyAliasFile::Section do
+  before(:all) { @section = @parser_result.sections[1]}
+
+  describe "#title" do
+    before(:each) { @title = @section.title }
+
+    it "returns the title text of the section" do
+      @title.should match(/Unix Command Line Aliases/)
+    end
+
+    it "removes the leading ## from the title" do
+      @title.should_not include('##')
+    end
+
+    it "removes leading and trailing whitespace from the title" do
+      @title[0,1].should_not include(' ')
+      @title[-1,1].should_not include(' ')
+      @title.should_not include("\n")
+    end
+  end
+
+  describe "#entries" do
+    it "returns one entry for each alias in the section" do
+      @section.entries.count.should eq(11)
+    end
+  end
+
+end

data/spec/sydney_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Sydney do
+
+  context "with a valid alias file" do
+  	it "parses the alias file" do
+      @parser_result.should be_true
+    end
+  end
+
+  context "with an invalid alias file" do
+    it "raises an exception and reports the offset where the problem occurred" do
+      expect {
+        Sydney.parse("blah blah")
+      }.to raise_error
+    end
+  end
+
+end

data/sydney.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sydney/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sydney"
+  gem.version       = Sydney::VERSION
+  gem.authors       = ["Geoff Harcourt"]
+  gem.email         = ["geoff.harcourt@gmail.com"]
+  gem.description   = %q{A Treetop parser for alias files}
+  gem.summary       = %q{Sydney parses alias files, dividing them into sections and alias entries, tying comments to entries.}
+  gem.homepage      = "http://github.com/geoffharcourt/sydney"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'treetop', '~> 1.4.12'
+
+  gem.add_development_dependency 'rspec', '~> 2.12'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sydney
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Geoff Harcourt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.12
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: A Treetop parser for alias files
+email:
+- geoff.harcourt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sydney.rb
+- lib/sydney/sydney_alias_file/grammar_rules.treetop
+- lib/sydney/sydney_alias_file/node_extensions.rb
+- lib/sydney/version.rb
+- spec/fixtures/aliases
+- spec/spec_helper.rb
+- spec/sydney_alias_file/alias_comment_spec.rb
+- spec/sydney_alias_file/alias_definition_spec.rb
+- spec/sydney_alias_file/alias_entry_spec.rb
+- spec/sydney_alias_file/document_spec.rb
+- spec/sydney_alias_file/section_spec.rb
+- spec/sydney_spec.rb
+- sydney.gemspec
+homepage: http://github.com/geoffharcourt/sydney
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sydney parses alias files, dividing them into sections and alias entries,
+  tying comments to entries.
+test_files:
+- spec/fixtures/aliases
+- spec/spec_helper.rb
+- spec/sydney_alias_file/alias_comment_spec.rb
+- spec/sydney_alias_file/alias_definition_spec.rb
+- spec/sydney_alias_file/alias_entry_spec.rb
+- spec/sydney_alias_file/document_spec.rb
+- spec/sydney_alias_file/section_spec.rb
+- spec/sydney_spec.rb