YAMLiner 0.3.0 → 0.3.1

data/README.rdoc

@@ -1,7 +1,8 @@
 = 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.
+This library extends given object instance with it's own methods and then you
+can use this instance to CRUD over files as comment lines in format of <b>inline YAML</b>
+line with your specified options.
 
 == Installation
 
@@ -24,7 +25,7 @@ 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')
+  >> my_hash.yamline_set(: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"

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/YAMLiner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{YAMLiner}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   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.date = %q{2010-08-01}
   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 = [

data/lib/yamliner.rb

@@ -3,7 +3,7 @@
 #<b>inline YAML</b>.
 #  a = {:name => 'selman', :surname => 'ulug'}
 #  YAMLiner::line a
-#  a.yamline_settings(:name => 'MyLine')
+#  a.yamline_set(:name => 'MyLine')
 require 'yaml'
 require 'fileutils'
 
@@ -24,29 +24,37 @@ module YAMLiner
       :writeto => '' }
 
     objects.each do |object|
-      if object.kind_of?(Array) or object.kind_of?(Hash)
+      if object.respond_to?(:to_yaml)
         object.extend(YAMLinerActions)
-        object.instance_variable_set(:@settings, settings)
+        object.instance_variable_set(:@yamline_settings, settings)
       else
-        raise "only Hash or Array classes supported: #{object.class} not supported"
+        raise "#{object.class} do not responding to to_yaml method"
       end
     end
   end
 
   #CRUD operation functions and some tools
   module YAMLinerActions
-    attr_reader :settings
+    attr_reader :yamline_settings
 
     #You can get inline YAML only redefining this method
     def to_yaml_style
       :inline
     end
 
+    #aliasing to_yaml_properties to remove our instance variable
+    alias to_yaml_properties_orginal to_yaml_properties
+
+    #removing our yamline_settings instance variable
+    def to_yaml_properties
+      to_yaml_properties_orginal - [:@yamline_settings]
+    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"
+      @yamline_settings[:prefix] + @yamline_settings[:name] + to_yaml.chop + @yamline_settings[:postfix] + "\n"
     end
 
     #YAMLiner settings default values
@@ -56,16 +64,16 @@ module YAMLiner
     #  :prefix => '#'
     #  :postfix => ''
     #  :writeto => ''
-    def yamline_settings(sets = {})
-      @settings.merge!(sets) unless sets.empty?
+    def yamline_set(settings = {})
+      @yamline_settings.merge!(settings) unless settings.empty?
     end
 
     #Reads your supplied file/files if successfull returns readed object 
-    #  Dir['**/*.txt'].each {|f| a.yamline_settins(:file => f); a.yamline_read } 
+    #  Dir['**/*.txt'].each {|f| a.yamline_set(: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])}$)}
+      matcher = %r{(^#{Regexp.escape(@yamline_settings[:prefix] + @yamline_settings[:name])})(.*?)(#{Regexp.escape(@yamline_settings[:postfix])}$)}
       line_l = []
       line_s = lines.select {|line| line =~ matcher; line_l << YAML::load($2) if $2 }
       return if line_s.empty?
@@ -74,18 +82,18 @@ module YAMLiner
 
     #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_set(:file => 'test.txt')
     #  a.yamline_write!
     def yamline_write!
       lines = file_lines || []
       yamline_delete!(lines) unless lines.empty?
-      lines.insert(settings[:line], yamline)
+      lines.insert(@yamline_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_set(:file => 'test.txt')
     #  a.yamline_delete!
     def yamline_delete!(lines = nil)
       lines = file_lines unless lines
@@ -98,15 +106,15 @@ module YAMLiner
     private
 
     def file_lines
-      file = @settings[:file]
+      file = @yamline_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?
+      writeto = @yamline_settings[:writeto]
+      writeto = @yamline_settings[:file] if writeto.empty?
       File.open(writeto, 'w+') { |file| file.puts temp }
       true
     end

data/spec/yamliner_spec.rb

@@ -11,21 +11,21 @@ describe "Yamliner" do
     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 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_set(: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_set(:file => @test_file)
     @input.yamline_read.should be_nil
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: YAMLiner
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Selman ULUG
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-17 00:00:00 +03:00
+date: 2010-08-01 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency