data-writer 0.9.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+data-writer
+===========
+
+Normally you can only read from DATA but with data-writer you can also write to it. This allows you to easily persist data in a source file.
+
+###Installation
+
+gem install data-writer
+
+###Usage
+
+Here is a simple example program that keeps track of how many times it has been executed and stores this as a YAML file in DATA.
+
+```ruby
+require 'data-writer'
+require 'yaml'
+
+store = YAML.load(DATA.read)
+puts "run = #{store['run']}"
+store["run"] += 1
+
+DATAWriter.file("w+") do |w|
+  w.write(store.to_yaml)
+end
+
+__END__
+---
+run: 1
+```
+
+Each time this program is run it will increment run by 1 and persist the result in the YAML hash.
+
+###API
+
+__DATAWriter.file(mode_string, opt = {})__
+
+A factory method that makes file objects which can write to data.
+mode_string and opt are the same as for File.new.
+If this method is called with a block it behaves as File.open and if it is called without
+a block it returns a File object as in File.new.
+
+Example:
+
+```ruby
+# append to DATA
+require 'data-writer'
+
+appender = DATAWriter.file("a")
+appender.write " my dear Watson"
+appender.close  # DATA.read => "Elementary my dear Watson"
+
+__END__
+Elementary
+```
+
+If this method is called and DATA is not defined then it will raise a DATANotFoundError exception.
+The file objects returned by this method have their #rewind method changed so that it seeks back to
+the start of DATA, and not back to the start of the file.
+

data/data-writer.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        	= 'data-writer'
+  s.version     	= '0.9.0'
+  s.date        	= '2012-07-15'
+  s.summary     	= "Allows you to write to DATA"
+  s.description 	= "Normally you can only read from DATA but with data-writer you can also write to it. This allows you to easily persist data in a source file."
+  s.authors     	= ["Kalle Lindstrom"]
+  s.email       	= ["lindstrom.kalle@gmail.com"]
+  s.homepage    	= "https://github.com/kl/data-writer"
+  s.files       	= %w[lib/data-writer.rb README.md data-writer.gemspec Gemfile]
+  s.require_paths = ['lib']
+  s.has_rdoc 		  = false
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('minitest')
+end

data/lib/data-writer.rb

@@ -0,0 +1,108 @@
+
+class DATAWriter
+
+  class DATANotFoundError < StandardError; end
+
+  #
+  # The position in the file where DATA starts (line after __END__)
+  #
+  def self.data_start_pos
+    @data_start_pos
+  end
+  
+  #
+  # Factory method for DATA writers. Works simliar to File.new.
+  #
+  def self.file(mode, opt={})
+    check_DATA_defined  # raises an exception if DATA is not defined.
+    data_path = File.expand_path(DATA.path)
+
+    if mode =~ /w/      # if we have a "w" we first need to delete everything after __END__.
+      clear_end
+      mode.include?("b") ? m = "rb+" : m = "r+"   # the actual mode will be rb+ or r+.
+      file = create_file(data_path, m, opt)
+    else
+      file = create_file(data_path, mode, opt)
+    end
+
+    @data_start_pos = scan_data_pos   # remeber the current position of __END__.
+    file.pos = @data_start_pos        # sets the file pos to the line after __END__.
+    enhanced = enhance_file(file)     # adds specialized methods for this object.
+
+    if block_given?
+      yield(enhanced)
+      enhanced.close
+    else
+      enhanced
+    end
+  end
+
+  #
+  # Helper method to create a file that works in both 1.8 and 1.9.
+  #
+  def self.create_file(path, mode_string, opt = {})
+    if RUBY_VERSION =~ /(1\.9)|(19)/
+      File.new(path, mode_string, opt)
+    else
+      File.new(path, mode_string)
+    end
+  end
+  private_class_method :create_file
+
+  #
+  # Deletes everything after __END__. This is used to simulate the "w" permission mode.
+  #
+  def self.clear_end
+    file_path = File.expand_path(DATA.path)
+    file_content = File.read(file_path)
+    new_content = file_content[/.+?^__END__$/m] + "\n"    # everything up to an including __END__.
+
+    File.open(file_path, "w") { |f| f.write(new_content) }
+  end
+  private_class_method :clear_end
+
+  #
+  # Finds the position in the file after __END__. DATA.pos isn't used because of
+  # problems when opening the file in "w" mode.
+  #
+  def self.scan_data_pos
+    source_file = File.new(File.expand_path($0))
+
+    until source_file.eof?
+      line = source_file.gets
+      if line =~ /^^__END__$/
+        pos = source_file.pos
+        source_file.close
+        return pos
+      end
+    end
+    source_file.close
+    raise DATANotFoundError, "DATA object does not exist. Ensure that the file has __END__"
+  end
+  private_class_method :scan_data_pos
+
+  #
+  # Adds specialized methods to the DATA writer object.
+  #
+  def self.enhance_file(object)
+
+    def object.rewind   # so that #rewind will go back to __END__ and not the beginning of the file.
+      self.pos = DATAWriter.data_start_pos
+    end
+
+    object
+  end
+  private_class_method :enhance_file
+
+  #
+  # Raises a DATANotFoundError exception if DATA is not defined.
+  #
+  def self.check_DATA_defined
+    begin
+      DATA
+    rescue NameError
+      raise DATANotFoundError, "DATA object does not exist. Ensure that the file has __END__"
+    end
+  end
+  private_class_method :check_DATA_defined
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: data-writer
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Kalle Lindstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Normally you can only read from DATA but with data-writer you can also
+  write to it. This allows you to easily persist data in a source file.
+email:
+- lindstrom.kalle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/data-writer.rb
+- README.md
+- data-writer.gemspec
+- Gemfile
+homepage: https://github.com/kl/data-writer
+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: Allows you to write to DATA
+test_files: []