YAMLiner 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Selman ULUG
+
+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.rdoc

@@ -0,0 +1,44 @@
+= What is this?
+
+With this library you gives a Hash or an Array instance and it extends this with it's own methods
+then you can CRUD on this instance <b>inline YAML</b> line with your specified options.
+
+== Installation
+
+  (sudo) gem install YAMLiner
+then in your source code;
+  require 'yamliner'
+
+= Usage Samples
+
+  >> my_hash = {:name => 'selman', :surname => 'ulug'}
+  => {:name=>"selman", :surname=>"ulug"}
+  >> YAMLiner::line my_hash
+  => [{:name=>"selman", :surname=>"ulug"}]
+  >> my_hash.yamline
+  => "#YAMLiner--- {:name: selman, :surname: ulug}\n"
+
+It supplies
+CRUD[http://en.wikipedia.org/wiki/Create,_read,_update_and_delete]
+operation functions #read, #delete!, #write! (creates and updates)
+you can change :name, :prefix, :postfix for every type of text file
+comment styles like this:
+
+  >> my_hash.yamline_settings(:prefix => '/*', :postfix => '*/', :name => 'my_c_comment')
+  => {:name=>"my_c_comment", :file=>"", :line=>0, :prefix=>"/*", :postfix=>"*/", :writeto=>""}
+  >> my_hash.yamline
+  => "/*my_c_comment--- {:name: selman, :surname: ulug}*/\n"
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Selman ULUG. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "YAMLiner"
+    gem.summary = "inline YAML CRUD operations"
+    gem.description = "Simple gem that supplies inline YAML CRUD operations that usable by all kind of text files."
+    gem.email = "selman.ulug@gmail.com"
+    gem.homepage = "http://github.com/selman/YAMLiner"
+    gem.authors = ["Selman ULUG"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/rake/task'
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = false
+    t.verbose = true
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = true
+    t.patterns = %w(lib/**/*.rb spec/**/*.rb)
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "YAMLiner #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/YAMLiner.gemspec

@@ -0,0 +1,55 @@
+# 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{YAMLiner}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Selman ULUG"]
+  s.date = %q{2010-07-17}
+  s.description = %q{Simple gem that supplies inline YAML CRUD operations that usable by all kind of text files.}
+  s.email = %q{selman.ulug@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "YAMLiner.gemspec",
+     "lib/yamliner.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/yamliner_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/selman/YAMLiner}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{inline YAML CRUD operations}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/yamliner_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/yamliner.rb

@@ -0,0 +1,116 @@
+#= YAMLiner
+#Simple library for CRUD operations on formatted comment lines with
+#<b>inline YAML</b>.
+#  a = {:name => 'selman', :surname => 'ulug'}
+#  YAMLiner::line a
+#  a.yamline_settings(:name => 'MyLine')
+require 'yaml'
+require 'fileutils'
+
+#YAMLiner module definition
+module YAMLiner
+  extend self
+
+  #extends given Array or Hash instance with YAMLinerActions
+  #  a = {:name => 'selman', :surname => 'ulug'}
+  #  YAMLiner::line a
+  def line(*objects)
+    settings =
+      {:name => 'YAMLiner',
+      :file => '',
+      :line => 0,
+      :prefix => '#',
+      :postfix => '',
+      :writeto => '' }
+
+    objects.each do |object|
+      if object.kind_of?(Array) or object.kind_of?(Hash)
+        object.extend(YAMLinerActions)
+        object.instance_variable_set(:@settings, settings)
+      else
+        raise "only Hash or Array classes supported: #{object.class} not supported"
+      end
+    end
+  end
+
+  #CRUD operation functions and some tools
+  module YAMLinerActions
+    attr_reader :settings
+
+    #You can get inline YAML only redefining this method
+    def to_yaml_style
+      :inline
+    end
+
+    #Returns generated YAMLiner line
+    #  >> a.yamline
+    #  => "#YAMLiner--- {:name: selman, :surname: ulug}\n"
+    def yamline
+      @settings[:prefix] + @settings[:name] + self.to_yaml.chop + @settings[:postfix] + "\n"
+    end
+
+    #YAMLiner settings default values
+    #  :name => 'YAMLiner'
+    #  :files => []
+    #  :line => 0
+    #  :prefix => '#'
+    #  :postfix => ''
+    #  :writeto => ''
+    def yamline_settings(sets = {})
+      @settings.merge!(sets) unless sets.empty?
+    end
+
+    #Reads your supplied file/files if successfull returns readed object 
+    #  Dir['**/*.txt'].each {|f| a.yamline_settins(:file => f); a.yamline_read } 
+    def yamline_read(lines = nil, loaded = true)
+      lines = file_lines unless lines
+      return unless lines
+      matcher = %r{(^#{Regexp.escape(@settings[:prefix] + @settings[:name])})(.*?)(#{Regexp.escape(@settings[:postfix])}$)}
+      line_l = []
+      line_s = lines.select {|line| line =~ matcher; line_l << YAML::load($2) if $2 }
+      return if line_s.empty?
+      loaded ? line_l : line_s
+    end
+
+    #Writes the generated YAMLiner line to supplied file/files if there
+    #is a same formated line it deletes and write again.
+    #  a.yamline_settings(:file => 'test.txt')
+    #  a.yamline_write!
+    def yamline_write!
+      lines = file_lines || []
+      yamline_delete!(lines) unless lines.empty?
+      lines.insert(settings[:line], yamline)
+      save_file(lines)
+    end
+
+    #Finds and deletes formatted line/lines from supplied
+    #file/files. if formetted line is not uniq it deletes all of them.
+    #  a.yamline_settings(:file => 'test.txt')
+    #  a.yamline_delete!
+    def yamline_delete!(lines = nil)
+      lines = file_lines unless lines
+      return unless lines
+      lines_readed = yamline_read(lines, false)
+      lines_readed.each {|lr| lines.delete(lr) } if lines_readed
+      save_file(lines)
+    end
+
+    private
+
+    def file_lines
+      file = @settings[:file]
+      return if file.empty?
+      return unless File.exists?(file)
+      File.readlines(file)
+    end
+
+    def save_file(temp)
+      writeto = @settings[:writeto]
+      writeto = @settings[:file] if writeto.empty?
+      File.open(writeto, 'w+') { |file| file.puts temp }
+      true
+    end
+
+  end # YAMLinerActions
+
+end # YAMLiner

data/spec/spec.opts

@@ -0,0 +1 @@
+--color -fn

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'yamliner'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+
+end

data/spec/yamliner_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Yamliner" do
+
+  before(:all) do
+    @test_file = File.join(Dir.pwd, 'spec/test.txt')
+    File.open(@test_file, 'w+') do |f|
+      f.puts "Test File"
+    end
+    @input = {:name => 'selman', :surname => 'ulug'}
+    YAMLiner::line @input
+  end
+
+  it "should raise exception other than Array or Hash" do
+    lambda { s=''; YAMLiner::line s}.should raise_exception
+  end
+
+  it "should return nil when no file specified to read" do
+    @input.yamline_read.should be_nil
+  end
+
+  it "should return nil when specified file is not available to read" do
+    @input.yamline_settings(:file => 'not_available.txt')
+    @input.yamline_read.should be_nil
+  end
+
+  it "should read specified file and return nil when no YAMLiner" do
+    @input.yamline_settings(:file => @test_file)
+    @input.yamline_read.should be_nil
+  end
+
+  it 'should write to file' do
+    @input.yamline_write!.should_not be_nil
+  end
+
+  it "should read file and two objects must be equal" do
+    @input.yamline_read.should_not be_nil
+    read_lines = @input.yamline_read
+    read_lines.each do |rl|
+      rl.size.should eql(@input.size)
+      @input.each do |k, v|
+        rl.has_key?(k).should be_true
+        rl.has_value?(v).should be_true
+      end
+    end
+  end
+
+  it 'should delete from file' do
+    @input.yamline_delete!.should_not be_nil
+    @input.yamline_read.should be_nil
+  end
+
+  after(:all) do
+    FileUtils.rm(@test_file)
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: YAMLiner
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Selman ULUG
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-17 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Simple gem that supplies inline YAML CRUD operations that usable by all kind of text files.
+email: selman.ulug@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- YAMLiner.gemspec
+- lib/yamliner.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/yamliner_spec.rb
+has_rdoc: true
+homepage: http://github.com/selman/YAMLiner
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: inline YAML CRUD operations
+test_files: 
+- spec/spec_helper.rb
+- spec/yamliner_spec.rb