khayyam 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2008-12-20
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+features/export.feature
+features/import.feature
+features/steps/export_steps.rb
+features/steps/import_steps.rb
+lib/khayyam.rb
+lib/topic.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/topic_spec.rb

data/README.txt

@@ -0,0 +1,107 @@
+= khayyam
+
+* http://khayyam.rubyforge.org
+
+== DESCRIPTION:
+
+A gem for easily moving data and definititions, such as vocabulary words and definitions to and from files
+
+== FEATURES/PROBLEMS:
+
+* See SYNOPSIS.
+
+== SYNOPSIS:
+
+    Export data to a string
+    
+    Example:
+      topic = Khayyam::Topic.new "vi"
+      topic.regarding "movement" do |items|
+        items["h"] = "left"
+        items["j"] = "up"
+      end
+      topic.regarding "commands" do |items|
+        items[":q"] = "quit"
+        items[":x"] = "save and quit"
+      end
+      output_string = topic.export
+      
+      
+    Import data from a string.
+    
+    Example:
+    topic = Khayyam::Topic.import my_data
+    topic.regarding "foo" do |facts|
+      puts facts["bar"]
+    end
+    
+    => "monkey"
+
+== REQUIREMENTS:
+
+* N/A
+
+== INSTALL:
+
+* sudo gem install khayyam
+
+== LICENSE:
+
+(The Ruby License)
+
+Copyright (c) 2008 Jamal Hansen
+
+  Khayyam is copyrighted free software by Jamal Hansen
+  <jamal.hansen at gmail dot com> and contributors. You can redistribute it and/or 
+  modify it under either the terms of the GPL2 or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise make them
+       Freely Available, such as by posting said modifications to Usenet or an
+       equivalent medium, or by allowing the author to include your
+       modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict with
+       standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+       together with instructions (in the manual page or equivalent) on where
+       to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of the
+       software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+require 'rubygems'
+require 'hoe'
+require 'cucumber/rake/task'
+require './lib/khayyam.rb'
+
+Hoe.new('khayyam', Khayyam::VERSION) do |p|
+  p.developer('Jamal Hansen', 'jamal.hansen@gmail.com')
+  p.changes=p.paragraphs_of("History.txt", 0..1).join("\n\n")
+end
+
+Cucumber::Rake::Task.new
+
+# vim: syntax=Ruby

data/features/export.feature

@@ -0,0 +1,17 @@
+Story: Exporting a single file
+  As a user of Khayyam
+  I want to export a file with khayyam
+  So that I can use the data elsewhere
+
+Scenario: Export a file containing a single category
+  Given an object containing data to export
+  When I tell khayaam to export the file
+  Then it will export the file
+  And it will contain all the data in the original objects
+  
+Scenario: Export a file containing multiple categories
+  Given an object containing multiple categories to export
+  When I tell khayaam to export the file
+  Then it will export the file
+  And it will contain all the data and categories in the original objects
+

data/features/import.feature

@@ -0,0 +1,11 @@
+Story: Importing a string
+  As a user of Khayyam
+  I want to import a string with khayyam
+  So that I can use it with my application
+  
+Scenario: Import a string containing a single category
+  Given a string containing data to import
+  When I tell khayaam to import the string
+  Then it will import the string into khayyam
+  And it will contain all the data in the string
+

data/features/steps/export_steps.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), *%w[.. .. spec spec_helper.rb])
+
+Given /^an object containing data to export$/ do
+  @topic = Khayyam::Topic.new "vi"
+  @topic.regarding "movement" do |items|
+    items["h"] = "left"
+    items["j"] = "up"
+    items["k"] = "down"
+    items["l"] = "right"
+    items["^"] = "beginning of line"
+    items["$"] = "end of line"
+    items["w"] = "beginning of next word"
+  end
+end
+
+When /^I tell khayaam to export the file$/ do
+  @output = @topic.export
+end
+
+Then /^it will export the file$/ do
+  @output.should_not eql(nil)
+end
+
+Then /^it will contain all the data in the original objects$/ do
+  @output.should eql("topic: vi\ncategories: \n  movement: \n    k: down\n    w: beginning of next word\n    l: right\n    $: end of line\n    ^: beginning of line\n    h: left\n    j: up\n")
+end
+
+Given /^an object containing multiple categories to export$/ do
+  @topic = Khayyam::Topic.new "vi"
+  @topic.regarding "movement" do |items|
+    items["h"] = "left"
+    items["j"] = "up"
+  end
+  @topic.regarding "commands" do |items|
+    items[":q"] = "quit"
+    items[":x"] = "save and quit"
+  end
+end
+
+Then /^it will contain all the data and categories in the original objects$/ do
+  @output.should eql(%{topic: vi\ncategories: \n  movement: \n    h: left\n    j: up\n  commands: \n    \":q\": quit\n    \":x\": save and quit\n})
+end
+
+
+
+

data/features/steps/import_steps.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), *%w[.. .. spec spec_helper.rb])
+
+Given /^a string containing data to import$/ do
+  @data = "topic: dairy\ncategories:\n  cheese:\n    cheddar: ubiquitous\n    blue: crumbly"
+end
+
+When /^I tell khayaam to import the string$/ do
+  @topic = Khayyam::Topic.import @data
+end
+
+Then /^it will import the string into khayyam$/ do
+  @topic.class.should eql(Khayyam::Topic)
+end
+
+Then /^it will contain all the data in the string$/ do
+  @topic.name.should eql("dairy")
+  @topic.categories.should eql(["cheese"])
+  @topic.regarding("cheese") do |fact|
+    fact["cheddar"].should eql("ubiquitous")
+    fact["blue"].should eql("crumbly")
+  end
+end
+
+
+

data/lib/khayyam.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'topic'
+
+module Khayyam
+  VERSION = '0.0.1'
+end

data/lib/topic.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+
+module Khayyam
+  
+  #= Overview
+  # Khayyam::Topic: The class for interacting with topic pairs.  
+  #
+  class Topic
+    attr_reader :name
+    
+    def initialize name, facts={}
+      @name = name
+      @facts = facts
+    end
+    
+    # returns an array of sub-topics
+    def categories
+      @facts.keys
+    end
+    
+    # used to work with sub-topics
+    def regarding category
+      @facts[category] ||= {}
+      yield @facts[category]
+    end
+    
+    # Export data to a string
+    # Example:
+    #   topic = Khayyam::Topic.new "vi"
+    #   topic.regarding "movement" do |items|
+    #     items["h"] = "left"
+    #     items["j"] = "up"
+    #   end
+    #   topic.regarding "commands" do |items|
+    #     items[":q"] = "quit"
+    #     items[":x"] = "save and quit"
+    #   end
+    #   output_string = topic.export
+    def export
+      output = YAML.dump_stream({'topic' => @name, 'categories' => @facts})
+      output[5..output.length]
+    end
+    
+    # Import data from a string.
+    # 
+    # Example:
+    # topic = Khayyam::Topic.import my_data
+    def self.import string
+      data = YAML.load "--- \n#{string}"
+      khayyam = Khayyam::Topic.new data["topic"], data["categories"]
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'khayyam'

data/spec/topic_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe Khayyam::Topic do
+  it "should take the topic as a string on creation" do
+    topic = Khayyam::Topic.new "foo"
+    topic.name.should eql("foo")
+  end
+  
+  it "should store topics and facts" do
+    topic = Khayyam::Topic.new "dairy"
+    topic.regarding "cheese" do |fact|
+      fact["cheddar"] = "ubiquitous"
+    end
+    
+    topic.categories.should eql(["cheese"])
+    topic.regarding "cheese" do |fact|
+      fact["cheddar"].should eql("ubiquitous")
+    end
+  end
+  
+  it "should export data to a YAML string" do
+    topic = Khayyam::Topic.new "dairy"
+    topic.regarding "cheese" do |fact|
+      fact["cheddar"] = "ubiquitous"
+    end
+    
+    output = topic.export
+    output.should eql("topic: dairy\ncategories: \n  cheese: \n    cheddar: ubiquitous\n")
+  end
+  
+  it "should import data from a YAML string" do
+    topic = Khayyam::Topic.import "topic: dairy\ncategories: \n  cheese: \n    cheddar: ubiquitous\n"
+    topic.name.should eql("dairy")
+    #topic.
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: khayyam
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jamal Hansen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-22 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: A gem for easily moving data and definititions, such as vocabulary words and definitions to and from files
+email: 
+- jamal.hansen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- features/export.feature
+- features/import.feature
+- features/steps/export_steps.rb
+- features/steps/import_steps.rb
+- lib/khayyam.rb
+- lib/topic.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/topic_spec.rb
+has_rdoc: true
+homepage: http://khayyam.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: khayyam
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A gem for easily moving data and definititions, such as vocabulary words and definitions to and from files
+test_files: []
+