spells 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b094afd2a13a91478d702cd86dac1ea10602459
+  data.tar.gz: 0aac6a32f783fb79646ee7a895fa598e1d266cbe
+SHA512:
+  metadata.gz: 834db832ac354959347a05a656ca92cb98b89f41fa6e24c93f7023c330327f6ba9a8b61120b70417ca3bd92b676764c0cb52ecdf2e3ec82183332043389b1e0c
+  data.tar.gz: 7e1ad9cc05a1ce606266305bd2f1fe2e85f6632bd0fcc521f5d15ec77dab2a9dd92897dfd6285995660b1349d1cef4e671bba16e916a0110d19a8e16d996cd70

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/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+spells

data/.ruby-version

@@ -0,0 +1,2 @@
+2.1.0
+

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Cohen
+
+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 @@
+# Spells
+
+Spells is a library for parsing the text on Magic the Gathering cards
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spells'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spells
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/spells/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/fixtures/cards.yml

@@ -0,0 +1,21 @@
+---
+- !ruby/object:Spells::Card
+  name: Nezumi Bone-Reader
+  text: |-
+    {B}, Sacrifice a creature: Target player discards a card. Activate this ability only any time you could cast a sorcery.
+
+- !ruby/object:Spells::Card
+  name: Squallmonger
+  text: |-
+    {2}: Squallmonger deals 1 damage to each creature with flying and each player. Any player may activate this ability.
+
+- !ruby/object:Spells::Card
+  name: Ghost-Lit Raider
+  text: |-
+    {2}{R}, {T}: Ghost-Lit Raider deals 2 damage to target creature.
+    Channel - {3}{R}, Discard Ghost-Lit Raider: Ghost-Lit Raider deals 4 damage to target creature.
+
+- !ruby/object:Spells::Card
+  name: Abomination
+  text: |-
+    Whenever Abomination blocks or becomes blocked by a green or white creature, destroy that creature at end of combat.

data/grammar/spells.treetop

@@ -0,0 +1,56 @@
+grammar Spells
+  include Spells::Punctuation
+  include Spells::Symbols
+
+  rule card_text
+    ability ( new_line ability )* <ParseNode>
+  end
+
+  rule ability
+    triggered_ability / activated_ability
+  end
+
+  rule triggered_ability
+    'Whenever' space words comma space effect <TriggeredAbility>
+  end
+
+  rule activated_ability
+    ( ability_word space dash space )? cost colon space effect <ActivatedAbility>
+  end
+
+  rule ability_word
+    'Channel' / 'Battalion'
+  end
+
+  rule cost
+    cost_part ( comma space cost_part )*
+  end
+
+  rule cost_part
+    mana_cost / tap_symbol / text_cost
+  end
+
+  rule mana_cost
+    mana_symbol+
+  end
+
+  rule tap_cost
+    tap_symbol
+  end
+
+  rule text_cost
+    words
+  end
+
+  rule effect
+    words dot ( space words dot )*
+  end
+
+  rule words
+    word ( space word )*
+  end
+
+  rule word
+    [A-Za-z1-9\-]+
+  end
+end

data/grammar/spells/punctuation.treetop

@@ -0,0 +1,35 @@
+module Spells
+  grammar Punctuation
+    rule new_line
+      "\n"
+    end
+
+    rule comma
+      ','
+    end
+
+    rule colon
+      ':'
+    end
+
+    rule space
+      ' '
+    end
+
+    rule dot
+      '.'
+    end
+
+    rule opening_brace
+      '{'
+    end
+
+    rule closing_brace
+      '}'
+    end
+
+    rule dash
+      '-'
+    end
+  end
+end

data/grammar/spells/symbols.treetop

@@ -0,0 +1,42 @@
+module Spells
+  grammar Symbols
+    include Punctuation
+
+    rule tap_symbol
+      opening_brace 'T' closing_brace
+    end
+
+    rule mana_symbol
+      mana_symbol_white /
+      mana_symbol_blue  /
+      mana_symbol_black /
+      mana_symbol_red   /
+      mana_symbol_green /
+      mana_symbol_colorless
+    end
+
+    rule mana_symbol_white
+      opening_brace 'W' closing_brace
+    end
+
+    rule mana_symbol_blue
+      opening_brace 'U' closing_brace
+    end
+
+    rule mana_symbol_black
+      opening_brace 'B' closing_brace
+    end
+
+    rule mana_symbol_red
+      opening_brace 'R' closing_brace
+    end
+
+    rule mana_symbol_green
+      opening_brace 'G' closing_brace
+    end
+
+    rule mana_symbol_colorless
+      opening_brace [1-9]+ closing_brace
+    end
+  end
+end

data/lib/spells.rb

@@ -0,0 +1,14 @@
+require 'treetop'
+require 'singleton'
+
+require "spells/version"
+
+module Spells
+  autoload :Parser,           'spells/parser'
+  autoload :ParseNode,        'spells/parse_node'
+
+  autoload :Card,             'spells/card'
+  autoload :Ability,          'spells/ability'
+  autoload :ActivatedAbility, 'spells/activated_ability'
+  autoload :TriggeredAbility, 'spells/triggered_ability'
+end

data/lib/spells/ability.rb

@@ -0,0 +1,4 @@
+module Spells
+  class Ability < ParseNode
+  end
+end

data/lib/spells/activated_ability.rb

@@ -0,0 +1,4 @@
+module Spells
+  class ActivatedAbility < Ability
+  end
+end

data/lib/spells/card.rb

@@ -0,0 +1,24 @@
+module Spells
+  class Card
+    attr_accessor :name
+    attr_accessor :text
+
+    def abilities
+      parsed_text.nodes_of Ability
+    end
+
+    def triggered_abilities
+      parsed_text.nodes_of TriggeredAbility
+    end
+
+    def activated_abilities
+      parsed_text.nodes_of ActivatedAbility
+    end
+
+    protected
+
+    def parsed_text
+      @parsed_text ||= Spells::Parser.instance.parse text
+    end
+  end
+end

data/lib/spells/parse_node.rb

@@ -0,0 +1,17 @@
+module Spells
+  class ParseNode < Treetop::Runtime::SyntaxNode
+    def nodes_of(klass)
+      ParseNode.nodes_of klass, self
+    end
+
+    def self.nodes_of(klass, tree)
+      return if tree.elements.nil?
+
+      tree.
+          elements.
+          map { |element| element.kind_of?(klass) ? element : nodes_of(klass, element) }.
+          flatten.
+          compact
+    end
+  end
+end

data/lib/spells/parser.rb

@@ -0,0 +1,16 @@
+module Spells
+  class Parser
+    include ::Singleton
+
+    def initialize
+      Treetop.load File.expand_path('../../../grammar/spells/punctuation.treetop', __FILE__)
+      Treetop.load File.expand_path('../../../grammar/spells/symbols.treetop', __FILE__)
+      Treetop.load File.expand_path('../../../grammar/spells.treetop', __FILE__)
+      @parser = SpellsParser.new
+    end
+
+    def parse(text)
+      @parser.parse text
+    end
+  end
+end

data/lib/spells/triggered_ability.rb

@@ -0,0 +1,4 @@
+module Spells
+  class TriggeredAbility < Ability
+  end
+end

data/lib/spells/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'spells'
+
+require 'yaml'
+
+def card_fixtures
+  @cards ||= YAML.load_file File.expand_path('../../fixtures/cards.yml', __FILE__)
+end
+
+def card_fixture(name)
+  card_fixtures.find { |card| card.name == name }
+end

data/spec/spells/card_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Spells::Card do
+
+  context '#abilities' do
+    it 'successfully parses abilities for all fixtures' do
+      card_fixtures.each do |card|
+        expect(card.abilities).not_to eq(nil)
+        expect(card.abilities).to be_an(Array)
+      end
+    end
+
+    it 'correctly parses abilities for "Nezumi Bone-Reader"' do
+      expect(card_fixture('Nezumi Bone-Reader').abilities.map { |ability| ability.text_value }).
+          to eq([
+                    '{B}, Sacrifice a creature: Target player discards a card. Activate this ability only any time you could cast a sorcery.'
+                ])
+    end
+
+    it 'correctly parses abilities for "Squallmonger"' do
+      expect(card_fixture('Squallmonger').abilities.map { |ability| ability.text_value }).
+          to eq([
+                    '{2}: Squallmonger deals 1 damage to each creature with flying and each player. Any player may activate this ability.'
+                ])
+    end
+
+    it 'correctly parses abilities for "Ghost-Lit Raider"' do
+      expect(card_fixture('Ghost-Lit Raider').abilities.map { |ability| ability.text_value }).
+          to eq([
+                    '{2}{R}, {T}: Ghost-Lit Raider deals 2 damage to target creature.',
+                    'Channel - {3}{R}, Discard Ghost-Lit Raider: Ghost-Lit Raider deals 4 damage to target creature.'
+                ])
+    end
+
+    it 'correctly parses abilities for "Abomination"' do
+      expect(card_fixture('Abomination').abilities.map { |ability| ability.text_value }).
+          to eq([
+                    'Whenever Abomination blocks or becomes blocked by a green or white creature, destroy that creature at end of combat.'
+                ])
+    end
+  end
+
+  context '#activated_abilities' do
+    it 'successfully parses activated abilities for all fixtures' do
+      card_fixtures.each do |card|
+        expect(card.activated_abilities).not_to eq(nil)
+        expect(card.activated_abilities).to be_an(Array)
+      end
+    end
+
+    it 'correctly parses activated abilities for "Nezumi Bone-Reader"' do
+      expect(card_fixture('Nezumi Bone-Reader').activated_abilities.map { |ability| ability.text_value }).
+          to eq([
+                    '{B}, Sacrifice a creature: Target player discards a card. Activate this ability only any time you could cast a sorcery.'
+                ])
+    end
+
+    it 'correctly parses activated abilities for "Squallmonger"' do
+      expect(card_fixture('Squallmonger').activated_abilities.map { |ability| ability.text_value }).
+          to eq([
+                    '{2}: Squallmonger deals 1 damage to each creature with flying and each player. Any player may activate this ability.'
+                ])
+    end
+
+    it 'correctly parses activated abilities for "Ghost-Lit Raider"' do
+      expect(card_fixture('Ghost-Lit Raider').activated_abilities.map { |ability| ability.text_value }).
+          to eq([
+                    '{2}{R}, {T}: Ghost-Lit Raider deals 2 damage to target creature.',
+                    'Channel - {3}{R}, Discard Ghost-Lit Raider: Ghost-Lit Raider deals 4 damage to target creature.'
+                ])
+    end
+
+    it 'correctly parses activated abilities for "Abomination"' do
+      expect(card_fixture('Abomination').activated_abilities.map { |ability| ability.text_value }).
+          to eq([])
+    end
+  end
+
+  context '#triggered_abilities' do
+    it 'successfully parses triggered abilities for all fixtures' do
+      card_fixtures.each do |card|
+        expect(card.triggered_abilities).not_to eq(nil)
+        expect(card.triggered_abilities).to be_an(Array)
+      end
+    end
+
+    it 'correctly parses triggered abilities for "Nezumi Bone-Reader"' do
+      expect(card_fixture('Nezumi Bone-Reader').triggered_abilities.map { |ability| ability.text_value }).
+          to eq([])
+    end
+
+    it 'correctly parses triggered abilities for "Ghost-Lit Raider"' do
+      expect(card_fixture('Ghost-Lit Raider').triggered_abilities.map { |ability| ability.text_value }).
+          to eq([])
+    end
+
+    it 'correctly parses triggered abilities for "Ghost-Lit Raider"' do
+      expect(card_fixture('Ghost-Lit Raider').triggered_abilities.map { |ability| ability.text_value }).
+          to eq([])
+    end
+
+    it 'correctly parses triggered abilities for "Abomination"' do
+      expect(card_fixture('Abomination').triggered_abilities.map { |ability| ability.text_value }).
+          to eq([
+                    'Whenever Abomination blocks or becomes blocked by a green or white creature, destroy that creature at end of combat.'
+                ])
+    end
+  end
+end

data/spec/spells/parser_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Spells::Parser do
+  describe '#parse' do
+    card_fixtures.each do |card|
+      it "successfully parses fixture card '#{card.name}'" do
+        expect(Spells::Parser.instance.parse(card.text)).not_to eq(nil)
+      end
+    end
+  end
+end

data/spec/spells_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Spells do
+  it 'has a version number' do
+    expect(Spells::VERSION).not_to be nil
+  end
+end

data/spells.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spells/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'spells'
+  spec.version       = Spells::VERSION
+  spec.authors       = ['Eric Cohen']
+  spec.email         = ['eirc.eirc@gmail.com']
+  spec.summary       = %q{Spells is a library for parsing the text on Magic the Gathering cards}
+  spec.homepage      = 'http://github.com/eirc/spells'
+  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_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'treetop'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: spells
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Cohen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-03 00:00:00.000000000 Z
+dependencies:
+- !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: 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: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eirc.eirc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fixtures/cards.yml
+- grammar/spells.treetop
+- grammar/spells/punctuation.treetop
+- grammar/spells/symbols.treetop
+- lib/spells.rb
+- lib/spells/ability.rb
+- lib/spells/activated_ability.rb
+- lib/spells/card.rb
+- lib/spells/parse_node.rb
+- lib/spells/parser.rb
+- lib/spells/triggered_ability.rb
+- lib/spells/version.rb
+- spec/spec_helper.rb
+- spec/spells/card_spec.rb
+- spec/spells/parser_spec.rb
+- spec/spells_spec.rb
+- spells.gemspec
+homepage: http://github.com/eirc/spells
+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.2
+signing_key: 
+specification_version: 4
+summary: Spells is a library for parsing the text on Magic the Gathering cards
+test_files:
+- spec/spec_helper.rb
+- spec/spells/card_spec.rb
+- spec/spells/parser_spec.rb
+- spec/spells_spec.rb