structr 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+Manifest
+doc
+pkg
+coverage
+tags

data/.watchr

@@ -0,0 +1,21 @@
+
+def run(*args)
+  system "ruby -rubygems -Ilib:test #{args.join(' ')}"
+end
+
+def run_tests
+  system "rake test"
+end
+
+def underscore(file)
+  file.gsub('/', '_')
+end
+
+watch('test/test_.*\.rb')  {|md| run md[0] }
+watch('lib/(.*)\.rb')      { run_tests }
+watch('test/helper.rb')    { run_tests }
+
+run_tests
+
+Signal.trap("QUIT") { abort("\n") }
+Signal.trap("INT") { run_tests }

data/README.rdoc

@@ -0,0 +1,74 @@
+= Structr
+
+Bind plain text to Ruby classes.
+NO TESTS!
+
+Inspired by ROXML http://github.com/Empact/roxml/tree/master
+
+== Usage
+
+  require 'structr'
+
+  Load = Struct.new(:one, :five, :fifteen)
+  ProcessItem = Struct.new(:pid, :user)
+
+  class Top
+    include Structr
+
+    converter :load do |(one, five, fifteen)|
+      Load.new(one.to_f, five.to_f, fifteen.to_f)
+    end
+
+    converter :process do |(pid, user)|
+      ProcessItem.new(pid.to_i, user)
+    end
+
+    field_accessor  :uptime, /top - (\d+):(\d+):(\d+)/ do |h, m, s|
+      h.to_i * 3600 + m.to_i * 60 + s.to_i
+    end
+    field_accessor  :cpu_string, /(Cpu.*?)\n/
+    load_accessor   :load, /load average: (\d+\.\d+), (\d+\.\d+), (\d+\.\d+)/
+    int_accessor    :tasks, /Tasks:\s+(\d+)/
+    int_accessor    :memory, /Mem:\s+(\d+)/
+    field           :processes, /^\s*(\d+)\s(\S+)/, &converter(:process)
+
+    def processes
+      @processes
+    end
+
+    def users
+      @processes.map {|p| p.user }.uniq
+    end
+
+    def highest_pid
+      @processes.map {|p| p.pid }.sort.last
+    end
+  end
+
+  top = Top.structr(`top -b -n 1`)
+
+  puts "Load is #{top.load.one}"
+  puts "Up since #{top.uptime} seconds"
+  puts top.cpu_string
+  puts "#{top.tasks} Tasks"
+  puts "#{top.memory / 1024}MB memory available"
+  puts "Users: #{top.users.join(", ")}"
+  puts "Highest PID: #{top.highest_pid}"
+
+=== Examples
+
+  See examples/ for further examples
+
+== Installation
+
+=== Gem
+
+  gem source -a http://gems.github.com
+  gem install splattael-structr
+
+== Authors:
+* Peter Suschlik
+
+== Changelog
+
+See CHANGELOG file.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "structr"
+  gem.summary = 'Parse plain text to Ruby classes.'
+  gem.email = "peter-structr@suschlik.de"
+  gem.homepage = "http://github.com/splattael/structr"
+  gem.authors = ["Peter Suschlik"]
+
+  gem.has_rdoc = true
+  gem.extra_rdoc_files = [ "README.rdoc" ]
+
+  gem.add_development_dependency "riot", ">= 0.10.4"
+  gem.add_development_dependency "riot_notifier", ">= 0.0.5"
+
+  gem.test_files = Dir.glob('test/test_*.rb')
+end
+
+Jeweler::GemcutterTasks.new
+
+# Test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList.new('test/test_*.rb')
+  test.libs << 'test'
+  test.verbose = true
+end
+
+# RDoc
+Rake::RDocTask.new do |rd|
+  rd.title = "Parse plain text with Ruby classes"
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/*.rb")
+  rd.rdoc_dir = "doc"
+end
+
+
+# Misc
+desc "Tag files for vim"
+task :ctags do
+  dirs = $LOAD_PATH.select {|path| File.directory?(path) }
+  system "ctags -R #{dirs.join(" ")}"
+end
+
+desc "Find whitespace at line ends"
+task :eol do
+  system "grep -nrE ' +$' *"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/examples/invoice.rb

@@ -0,0 +1,42 @@
+require 'structr'
+
+LineItem = Struct.new(:number, :description, :price)
+
+class Invoice
+  include Structr
+
+  converter :line_item do |*matched|
+    LineItem.new(*matched)
+  end
+
+  int_accessor    :number,      /#(\d+)/
+  field_accessor  :address,     /Address:\n(.*?)\n(.*?)\n(.*?)\n/
+  date_accessor   :date,        /on (\d+-\d+-\d+)/
+  line_item       :line_items,  /^(\d+)\.\s+(.*?)\s+(\d+,\d+)$/
+
+  def items
+    Array(@line_items)
+  end
+end
+
+string = (STDIN.tty? ? DATA : STDIN).read
+
+invoice = Invoice.structr(string)
+p invoice
+p invoice.items
+p invoice.number
+
+__END__
+This is #23             on 2009-04-30
+
+Address:
+Evergreen Street 23
+12345 Malrose
+Nirvana
+
+1. Root server  23,42
+2. Domain       45,00
+3. Another      32,00
+
+# TODO
+ * Subtypes? LineItem

data/examples/top.rb

@@ -0,0 +1,47 @@
+require 'structr'
+
+Load = Struct.new(:one, :five, :fifteen)
+ProcessItem = Struct.new(:pid, :user)
+
+class Top
+  include Structr
+
+  converter :load do |(one, five, fifteen)|
+    Load.new(one.to_f, five.to_f, fifteen.to_f)
+  end
+
+  converter :process do |(pid, user)|
+    ProcessItem.new(pid.to_i, user)
+  end
+
+  field_accessor  :uptime, /top - (\d+):(\d+):(\d+)/ do |h, m, s|
+    h.to_i * 3600 + m.to_i * 60 + s.to_i
+  end
+  field_accessor  :cpu_string, /(Cpu.*?)\n/
+  load_accessor   :load, /load average: (\d+\.\d+), (\d+\.\d+), (\d+\.\d+)/
+  int_accessor    :tasks, /Tasks:\s+(\d+)/
+  int_accessor    :memory, /Mem:\s+(\d+)/
+  field           :processes, /^\s*(\d+)\s(\S+)/, &converter(:process)
+
+  def processes
+    @processes
+  end
+
+  def users
+    @processes.map {|p| p.user }.uniq
+  end
+
+  def highest_pid
+    @processes.map {|p| p.pid }.sort.last
+  end
+end
+
+top = Top.structr(`top -b -n 1`)
+
+puts "Load is #{top.load.one}"
+puts "Up since #{top.uptime} seconds"
+puts top.cpu_string
+puts "#{top.tasks} Tasks"
+puts "#{top.memory / 1024}MB memory available"
+puts "Users: #{top.users.join(", ")}"
+puts "Highest PID: #{top.highest_pid}"

data/lib/structr.rb

@@ -0,0 +1,112 @@
+
+module Structr
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    Converter = {
+      :int    =>  proc {|m| m.to_i },
+      :float  =>  proc {|m| m.to_f },
+      :date   =>  proc {|m| Date.parse(m) },
+      :string =>  proc {|m| m },
+    }
+
+    def field(name, regexp, options={}, &block)
+      fields << FieldDefinition.new(name, regexp, &block)
+
+      case options[:accessor]
+      when :reader
+        attr_reader(name)
+      when :writer
+        attr_writer(name)
+      when :accessor, true
+        attr_accessor(name)
+      end
+    end
+
+    def field_accessor(name, regexp, &block)
+      field(name, regexp, :accessor => true, &block)
+    end
+
+    def field_reader(name, regexp, &block)
+      field(name, regexp, :accessor => :reader, &block)
+    end
+
+    def field_writer(name, regexp, &block)
+      field(name, regexp, :accessor => :writer, &block)
+    end
+
+    def fields
+      @fields ||= []
+    end
+
+    def structr(content, *options)
+      instance = new(*options)
+      fields.each do |field|
+        value = field.match(content)
+        value = value.first if value.size < 2
+        if instance.respond_to?(field.setter)
+          instance.send(field.setter, value)
+        else
+          instance.instance_variable_set(field.ivar, value)
+        end
+      end
+      instance
+    end
+
+    def converter(name, proc=nil, &block)
+      if block = proc || block
+        Converter[name] = block
+      else
+        Converter[name]
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      name = method.to_s.gsub(/_(accessor|reader|writer)/, '')
+      if converter = converter(name.to_sym)
+        field(args[0], args[1], :accessor => $1 ? $1.to_sym : nil, &converter)
+      else
+        super(method, *args, &block)
+      end
+    end
+
+  end
+
+  class FieldDefinition
+
+    attr_accessor :name, :block
+
+    def initialize(name, regexp, &block)
+      @name, @regexp, @block = name.to_s, regexp, block
+    end
+
+    def setter
+      :"#{name}="
+    end
+
+    def getter
+      :"#{name}"
+    end
+
+    def ivar
+      :"@#{name}"
+    end
+
+    def match(string)
+      string.scan(@regexp).map do |matched|
+        matched = matched.first  if matched.size == 1
+        if @block
+          @block.call(*matched)
+        else
+          matched
+        end
+      end
+    end
+
+  end
+
+end

data/structr.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{structr}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Suschlik"]
+  s.date = %q{2009-12-07}
+  s.email = %q{peter-structr@suschlik.de}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".watchr",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/invoice.rb",
+     "examples/top.rb",
+     "lib/structr.rb",
+     "structr.gemspec",
+     "test/helper.rb",
+     "test/test_field_descriptor.rb",
+     "test/test_structr.rb"
+  ]
+  s.homepage = %q{http://github.com/splattael/structr}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Parse plain text to Ruby classes.}
+  s.test_files = [
+    "test/test_field_descriptor.rb",
+     "test/test_structr.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<riot>, [">= 0.10.4"])
+      s.add_development_dependency(%q<riot_notifier>, [">= 0.0.5"])
+    else
+      s.add_dependency(%q<riot>, [">= 0.10.4"])
+      s.add_dependency(%q<riot_notifier>, [">= 0.0.5"])
+    end
+  else
+    s.add_dependency(%q<riot>, [">= 0.10.4"])
+    s.add_dependency(%q<riot_notifier>, [">= 0.0.5"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'structr'
+
+require 'riot'
+require 'riot_notifier'
+
+Riot.reporter = RiotNotifier::Libnotify

data/test/test_field_descriptor.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+include Structr
+
+context Struct::FieldDefinition do
+  context "with single" do
+    setup { FieldDefinition.new(:number, /(\d+)/) }
+
+    asserts("name") { topic.name }.equals("number")
+    asserts("getter") { topic.getter }.equals(:number)
+    asserts("setter") { topic.setter }.equals(:number=)
+    asserts("ivar") { topic.ivar }.equals(:@number)
+    asserts("no block") { topic.block }.nil
+    asserts("no match") { topic.match("no match") }.equals([])
+    asserts("match without block") { topic.match("23 < 42") }.equals(["23", "42"])
+    asserts("match with block") do
+      topic.block = proc { |m| m.to_i }
+      topic.match("23 < 42")
+    end.equals([23, 42])
+  end
+
+  context "multiple" do
+    setup { FieldDefinition.new(:number, /(\d+),(\d+)/) }
+
+    asserts("match without block") { topic.match("costs 23,42$") }.equals([["23", "42"]])
+    asserts("matech with block") do
+      topic.block = proc {|(dollar, cents)| dollar.to_i * 100 + cents.to_i }
+      topic.match("costs 23,42$")
+    end.equals([2342])
+  end
+end

data/test/test_structr.rb

@@ -0,0 +1,146 @@
+require 'helper'
+
+context Structr do
+  setup do
+    Class.new do
+      include Structr
+    end
+  end
+
+  asserts("module inclusion") { topic.included_modules.include?(Structr) }
+  %w(field field_reader field_writer field_accessor converter structr fields).each do |method|
+    asserts("responds to #{method}").respond_to(method)
+  end
+  asserts("no fields") { topic.fields.empty? }
+
+  asserts("error on no field name") { topic.field }.raises(ArgumentError)
+  asserts("error on no regexp") { topic.field(:name) }.raises(ArgumentError)
+
+  context "with field" do
+    context "added" do
+      setup do
+        topic.field :foo, %r{}
+        topic.field :bar, %r{}
+        topic.field :baz, %r{}
+        topic
+      end
+
+      asserts("3 added") { topic.fields.size }.equals(3)
+    end
+
+    context "defaults" do
+      setup do
+        topic.field(:no_acc_1, %r{})
+        topic.field(:no_acc_2, %r{}, :accessor => false)
+      end
+      [ :acc_1, :acc_2 ].each do |field|
+        asserts("no getter for #{field}") { !topic.respond_to?(field) }
+        asserts("no setter for #{field}") { !topic.respond_to?(:"#{field}=") }
+      end
+    end
+
+    context "accessors" do
+      setup do
+        topic.field(:acc_1, %r{}, :accessor => true)
+        topic.field(:acc_2, %r{}, :accessor => :accessor)
+        topic.field_accessor(:acc_3, %r{})
+        topic.new
+      end
+
+      [ :acc_1, :acc_2, :acc_3 ].each do |method|
+        asserts("has getter for #{method}") { topic.respond_to?(method) }
+        asserts("has setter for #{method}") { topic.respond_to?(:"#{method}=") }
+      end
+    end
+
+    context "readers" do
+      setup do
+        topic.field(:rdr_1, %r{}, :accessor => :reader)
+        topic.field_reader(:rdr_2, %r{})
+        topic.new
+      end
+
+      [ :rdr_1, :rdr_2 ].each do |method|
+        asserts("has getter for #{method}") { topic.respond_to?(method) }
+        asserts("has no sett for #{method}") { !topic.respond_to?(:"#{method}=") }
+      end
+    end
+
+    context "writers" do
+      setup do
+        topic.field(:wrt_1, %r{}, :accessor => :writer)
+        topic.field_writer(:wrt_2, %r{})
+        topic.new
+      end
+
+      [ :wrt_1, :wrt_2 ].each do |method|
+        asserts("has no getter for #{method}") { !topic.respond_to?(method) }
+        asserts("has setter for #{method}") { topic.respond_to?(:"#{method}=") }
+      end
+    end
+  end # with field
+
+  context "with converter" do
+    [ :int, :float, :date, :string ].each do |name|
+      asserts("default converter #{name} is a Proc") { topic.converter(name) }.kind_of(Proc)
+    end
+
+    [ :unkn, :unkn_reader, :unkn_writer, :unkn_accessor ].each do |field_name|
+      asserts("raises NoMethodError for #{field_name}") { topic.send(field_name, %r{}) }.raises(NoMethodError)
+    end
+
+    context "added" do
+      setup do
+        topic.converter(:proced, proc { |p| p })
+        topic.converter(:blocked) { |p| p }
+        topic
+      end
+
+      asserts("proced converter is a Proc") { topic.converter(:proced) }.kind_of(Proc)
+      asserts("blocked converter is a Proc") { topic.converter(:blocked) }.kind_of(Proc)
+    end
+
+    context "by-passed" do
+      setup do
+        pass = proc { |p| p }
+
+        topic.converter :pass, &pass
+        topic.field(:block, /(\d+)/) { |p| pass.call(p) }
+        topic.field(:param, /(\d+)/, &topic.converter(:pass))
+        topic.pass(:mm, /(\d+)/)
+        topic.pass(:mm_overwritten, /(\d+)/) { |i| fail("I am overwritten") }
+        topic
+      end
+
+      asserts("block field passes 1") { topic.fields[0].block.call(1) }.equals(1)
+      asserts("param field passes 1") { topic.fields[1].block.call(1) }.equals(1)
+      asserts("mm field passes 1") { topic.fields[2].block.call(1) }.equals(1)
+      asserts("mm_overwritten field passes 1") { topic.fields[3].block.call(1) }.equals(1)
+    end
+
+    context "using method missing" do
+      setup do
+        topic.int(:no_acc, %r{})
+        topic.int_reader(:rdr, %r{})
+        topic.int_writer(:wrt, %r{})
+        topic.int_accessor(:acc, %r{})
+        topic.new
+      end
+
+      asserts("no getter for no_acc") { !topic.respond_to?(:no_acc) }
+      asserts("no setter for no_acc") { !topic.respond_to?(:no_acc=) }
+      asserts("getter for rdr") { topic.respond_to?(:rdr) }
+      asserts("no setter for rdr") { !topic.respond_to?(:rdr=) }
+      asserts("no getter for wrt") { !topic.respond_to?(:wrt) }
+      asserts("setter for wrt") { topic.respond_to?(:wrt=) }
+      asserts("getter for acc") { topic.respond_to?(:acc) }
+      asserts("setter for acc") { topic.respond_to?(:acc=) }
+
+    end
+
+  end # with converters
+
+  # TODO test structr
+  # TODO integration tests
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: structr
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Peter Suschlik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: riot_notifier
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+    version: 
+description: 
+email: peter-structr@suschlik.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- .watchr
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/invoice.rb
+- examples/top.rb
+- lib/structr.rb
+- structr.gemspec
+- test/helper.rb
+- test/test_field_descriptor.rb
+- test/test_structr.rb
+has_rdoc: true
+homepage: http://github.com/splattael/structr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Parse plain text to Ruby classes.
+test_files: 
+- test/test_field_descriptor.rb
+- test/test_structr.rb