bit-struct 0.13.1

data/lib/bit-struct/vector-field.rb

@@ -0,0 +1,77 @@
+require 'bit-struct/vector'
+
+class BitStruct
+  # Class for embedding a BitStruct::Vector as a field within a BitStruct.
+  # Declared with BitStruct.vector.
+  class VectorField < Field
+    # Used in describe.
+    def self.class_name
+      @class_name ||= "vector"
+    end
+    
+    # Used in describe.
+    def class_name
+      @class_name ||= vector_class.name[/\w+$/]
+    end
+    
+    # Returns the subclass of Vector that is used to manage the value of this
+    # field. If the class was specified in the BitStruct.vector declaration,
+    # #vector_class will return it, otherwise it will be an anonymous class
+    # (which you can assign to a constant to make nonymous ;).
+    def vector_class
+      @vector_class ||= options[:vector_class] || options["vector_class"]
+    end
+
+    def describe opts # :nodoc:
+      if opts[:expand]
+        opts = opts.dup
+        opts[:byte_offset] = offset / 8
+        opts[:omit_header] = opts[:omit_footer] = true
+        vector_class.describe(nil, opts) {|desc| yield desc}
+      else
+        super
+      end
+    end
+
+    def add_accessors_to(cl, attr = name) # :nodoc:
+      unless offset % 8 == 0
+        raise ArgumentError,
+          "Bad offset, #{offset}, for vector field #{name}." +
+          " Must be multiple of 8."
+      end
+      
+      unless length % 8 == 0
+        raise ArgumentError,
+          "Bad length, #{length}, for vector field #{name}." +
+          " Must be multiple of 8."
+      end
+      
+      offset_byte = offset / 8
+      length_byte = length / 8
+      last_byte = offset_byte + length_byte - 1
+      byte_range = offset_byte..last_byte
+
+      vc = vector_class
+      
+      cl.class_eval do
+        define_method attr do ||
+          vc.new(self[byte_range])
+        end
+
+        define_method "#{attr}=" do |val|
+          if val.length != length_byte
+            raise ArgumentError, "Size mismatch in vector field assignment " +
+              "to #{attr} with value #{val.inspect}"
+          end
+          
+          if val.class != vc
+            warn "Type mismatch in vector field assignment " +
+              "to #{attr} with value #{val.inspect}"
+          end
+          
+          self[byte_range] = val
+        end
+      end
+    end
+  end
+end

data/lib/bit-struct/vector.rb

@@ -0,0 +1,173 @@
+# A Vector is, like a BitStruct, a String. It retains all of the String
+# methods, except for #[], #[]=, and #each. These methods operate on entries
+# instead of chars. Other methods, including #length and #slice, are unchanged.
+# Hence a Vector can be used directly with sockets, binary files, etc.
+#
+# Note that Vector is not a subclass of BitStruct. It cannot be used in
+# a #nest declaration in a BitStruct. Instead, use the #vector declaration.
+# See BitStruct::VectorField.
+#
+# Different instances of the same Vector class may have different lengths, and
+# a single instance can change its length. The length should always be a
+# multiple of the struct size.
+class BitStruct::Vector < String
+  include Enumerable
+
+  @default_options = {}
+  @struct_class = nil
+
+  class << self
+    def inherited cl
+      cl.instance_eval do
+        @struct_class = nil
+      end
+    end
+    
+    # Called as a class method with a single argument in a user-defined
+    # subclass to specify a particular BitStruct class to use for each entry,
+    # instead of generating an anonymous class. Called without arguments to
+    # access the struct class, generating an anonymous one if needed.
+    # The struct_class inherits from the struct_class of the parent Vector
+    # class.
+    def struct_class cl = nil
+      if cl
+        if @struct_class
+          warn "changing struct_class in #{self} to #{cl}"
+        end
+        @struct_class = cl
+        @struct_class.default_options default_options
+      else
+        unless @struct_class
+          @struct_class = self == BitStruct::Vector ? BitStruct : 
+            Class.new(superclass.struct_class)
+          @struct_class.default_options default_options
+        end
+      end
+      @struct_class
+    end
+
+    def method_missing(*a, &block)  # :nodoc:
+      struct_class.send(*a, &block)
+    end
+
+    alias :orig_respond_to? :respond_to?
+    def respond_to?(*m)  # :nodoc:
+      orig_respond_to?(*m) || struct_class.respond_to?(*m)
+    end
+    
+    # Get or set the hash of default options for the class, which apply to all
+    # fields in the entries. If +h+ is provided, update the default options
+    # with that hash. Default options are inherited.
+    #
+    # This is especially useful with the <tt>:endian => val</tt> option.
+    def default_options h = nil
+      @default_options ||= superclass.default_options.dup
+      if h
+        @default_options.merge! h
+        if @struct_class
+          @struct_class.default_options h
+        end
+      end
+      @default_options
+    end
+    
+    def describe(*args)
+      fmt = args[0] || BitStruct.describe_format
+      if block_given?
+        struct_class.describe(*args){|desc| yield desc}
+        yield ["..."]*5
+      else
+        struct_class.describe(*args) + [fmt % (["..."]*5)]
+      end
+    end
+  end
+    
+  # Convenience method for instances. Returns the BitStruct class that
+  # describes each entry.
+  def struct_class
+    self.class.struct_class
+  end
+  
+  # Convenience method for instances. Returns the string length in bytes of 
+  # each entry in the vector.
+  def struct_class_length
+    self.class.struct_class.round_byte_length
+  end
+  
+  # +arg+ can be an integer (number of entries) or a string
+  # (binary data, such as another Vector of the same size).
+  def initialize arg   # :yields: instance
+    case arg
+    when Integer
+      super(struct_class.initial_value * arg)
+    
+    else
+      begin
+        super arg
+      rescue NameError
+        raise ArgumentError, "must be string or integer: #{arg.inspect}"
+      end
+    end 
+
+    yield self if block_given?
+  end
+  
+  # Get the +i+-th entry. Returns a *copy* of the entry. If you want to
+  # use this copy to modify the entry, you must modify the copy and then
+  # use #[]= to replace the entry with the copy.
+  def [](i)
+    sc = self.class.struct_class
+    entry_length = sc.round_byte_length
+
+    unless (0...(length / entry_length)).include? i
+      raise ArgumentError, "index out of range: #{i}"
+    end
+    
+    sc.new slice(entry_length * i, entry_length)
+  end
+  
+  alias _old_replace_substr []=
+
+  # Set the +i+-th entry to +val+.
+  def []=(i,val)
+    entry_length = struct_class_length
+    
+    unless (0...(length / entry_length)).include? i
+      raise ArgumentError, "index out of range: #{i}"
+    end
+    
+    unless val.length == entry_length
+      raise ArgumentError, "wrong entry length: #{val.length} != #{entry_length}"
+    end
+    
+    _old_replace_substr(entry_length * i, entry_length, val)
+  end
+  
+  ## TODO: [i..j] etc.
+  
+  # Iterate over entries.
+  def each
+    entry_length = struct_class_length
+    (length / entry_length).times do |i|
+      yield self[i]
+    end
+  end
+  
+  def inspect(opts = BitStruct::DEFAULT_INSPECT_OPTS)
+    if opts[:include_class]
+      opts = opts.dup
+      opts[:include_class] = false
+      s = self.class.inspect + ": "
+    else
+      s = ""
+    end
+    
+    s << entries.map{|entry| entry.inspect(opts)}.join(opts[:separator])
+    lb, rb = opts[:brackets]
+    [lb, s, rb].join
+  end
+  
+  def inspect_detailed
+    inspect(BitStruct::DETAILED_INSPECT_OPTS)
+  end
+end

data/lib/bit-struct/yaml.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+
+class BitStruct
+  if RUBY_VERSION == "1.8.2"
+    def is_complex_yaml? # :nodoc:
+      true
+    end
+
+    YAML.add_ruby_type(/^bitstruct/) do |type, val|
+      subtype, subclass = YAML.read_type_class(type, Object)
+      subclass.new(val)
+    end
+
+    def to_yaml_type # :nodoc:
+      "!ruby/bitstruct:#{self.class}"
+    end
+
+    def to_yaml( opts = {} ) # :nodoc:
+      opts[:DocType] = self.class if Hash === opts
+      YAML.quick_emit(self.object_id, opts) do |out|
+        out.map(to_yaml_type) do |map|
+          fields.each do |field|
+            fn = field.name
+            map.add(fn, send(fn))
+          end
+        end
+      end
+    end
+
+  else
+    yaml_as "tag:path.berkeley.edu,2006:bitstruct"
+
+    def to_yaml_properties # :nodoc:
+      yaml_fields = fields.select {|field| field.inspectable?}
+      props = yaml_fields.map {|f| f.name.to_s}
+      if (rest_field = self.class.rest_field)
+        props << rest_field.name.to_s
+      end
+      props
+    end
+
+    # Return YAML representation of the BitStruct.
+    def to_yaml( opts = {} )
+      YAML::quick_emit( object_id, opts ) do |out|
+        out.map( taguri, to_yaml_style ) do |map|
+          to_yaml_properties.each do |m|
+            map.add( m, send( m ) )
+          end
+        end
+      end
+    end
+
+    def self.yaml_new( klass, tag, val ) # :nodoc:
+      unless Hash === val
+        raise YAML::TypeError, "Invalid BitStruct: " + val.inspect
+      end
+
+      bitstruct_name, bitstruct_type = YAML.read_type_class( tag, BitStruct )
+
+      st = bitstruct_type.new
+
+      val.each do |k,v|
+        st.send( "#{k}=", v )
+      end
+
+      st
+    end
+  end
+end

data/tasks/ann.rake

@@ -0,0 +1,80 @@
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/bones.rake

@@ -0,0 +1,20 @@
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,201 @@
+
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+end  # namespace :gem
+
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+remove_desc_for_task 'gem:clobber_package'
+
+# EOF