kstarv 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmMxNDMwY2YzNDM1MzZjOTUzZjgxMjY2ZjA3YTJlZWYzNTBjZmU5Yw==
+  data.tar.gz: !binary |-
+    MGI2NGVlODk2MDFiMzg5NzRmOGU2MzY5YTc0Y2Q3MTJjMGJjYTcwZg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDFlNTM1YWEyMTVlZjRiMTdlNmZjOGJjYmE4Yzc4ZTIwNWVkNWM0M2EzZGNh
+    NjY0MzhkZDRjYjZmNmNmNDczZmE3MTJhMGNmODFjZDZlMWNmYzE5OTA2YTBl
+    OTRmN2Y1OWZkZDM4MzIyODdhMjc2MjZmYzZmOTk4YzgxMDRmMTk=
+  data.tar.gz: !binary |-
+    NGQ0N2EzNDA5NTJkYWJjMWNhZjU5NzZhOTI5ODgyZjdkODhhODY5N2UwNzQx
+    NGY4Mjc4MmE3ZDM2NjVmZjQxYjFkMDliYzhlYWNkZWRmN2FlMWM1YzFkMGFh
+    YmI1Njk0ZjQyNzg1ZTFiYzJlMGU3OGUxOWI0YjQwZjczNGZmOWM=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+script: "bundle exec rspec spec/"
+
+notifications:
+  email:
+    - simlegate@163.com
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in kstarv.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { 'spec' }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/factories/(.+)_factory\.rb$}){ "factories" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 都是牛奶装什么特仑苏丶
+
+MIT License
+
+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.md

@@ -0,0 +1,92 @@
+# Kstarv
+
+Wrap a Ruby object by parsing file including key-values
+
+[![Build Status](https://travis-ci.org/simlegate/kstarv.png?branch=master)](https://travis-ci.org/simlegate/kstarv)
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kstarv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kstarv
+
+## Example text file
+centos network config file
+```ruby
+DEVICE=eth0
+HWADDR=00:1E:67:24:E8:2D
+TYPE=Ethernet
+UUID=8dc70db4-9c80-4757-807b-6419d864f74d
+ONBOOT=yes
+NM_CONTROLLED=no
+BOOTPROTO=static
+IPADDR=192.168.0.201
+NETMASK=255.255.255.0
+GATEWAY=192.168.0.1
+BORADCAST=192.168.0.255
+```
+## Usage
+set decollator spliting key and vaule
+```ruby
+# decollator is '=' by default
+@kv = Kstarv.from(/path/to/config) 
+# set decollator to '*'
+@kv = Kstarv.from(/path/to/config, '*') 
+```
+
+set key case  
+```ruby
+  # 'upcase' or 'downcase'
+  @kv.case = 'upcase'
+  @kv.write
+```
+read value by key
+```ruby
+@kv.device  # => eth0
+@kv.ipaddr  # => 192.168.0.201
+....
+```
+
+write value
+```ruby
+@kv.ipaddr  # => 127.0.0.1
+@kv.write
+# output:
+#    ......
+#    BOOTPROTO=static
+#    IPADDR=127.0.0.1  # => changed
+#    NETMASK=255.255.255.0
+#    GATEWAY=192.168.0.1
+#    BORADCAST=192.168.0.255
+#    ....
+```
+set key case
+```ruby
+# you can set case of key
+# downcase and @case is true by default
+@kv.case = false
+@kv.write
+# output:
+#    ......
+#    bootproto=static
+#    ipaddr=192.168.0.201
+#    netmask=255.255.255.0
+#    gatewaY=192.168.0.1
+#    boradcast=192.168.0.255
+#    ....
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kstarv.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kstarv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kstarv"
+  spec.version       = Kstarv::VERSION
+  spec.authors       = ["都是牛奶装什么特仑苏丶"]
+  spec.email         = ["simlegate@163.com"]
+  spec.description   = %q{Wrap a Ruby object by parsing text file including key-values}
+  spec.summary       = %q{Wrap a Ruby object by parsing text file including key-values}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rspec'
+end

data/lib/kstarv/k_v.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+module Kstarv
+  class KV
+    # set key downcase or upcase
+    # @kv.case = true
+    # downcase and @case is true by default
+    # @kv.write
+    attr_accessor :case
+
+    def initialize file, join='='
+      @case ||= true
+      @file = file
+      @join = join
+      @instance_vars  = []
+      load_attr
+    end
+
+    # @net_work_config.ipaddr = '127.0.0.1'
+    # @net_work_config.write
+    def write
+      kvs = @instance_vars.map do | var |
+	# TODO var upcase or downcase
+	# 调用case method
+	"#{convert_case(var)}=#{instance_var_get(var)}"
+      end
+      # kvs =>  [ "DEVICE=eth0", "HWADDR=00:1E:67:24:E8:2D", "TYPE=Ethernet" ...]
+
+      # r+是覆盖写，w+是清除后写，a+是追加写
+      File.open(@file, 'w+') do |f|
+	kvs.map do |kv|
+	  f.write(kv)
+	  f.puts
+	end
+      end
+    end
+
+
+    def load_attr
+      File.open(@file) do |f|
+	f.each do |line|
+	  # remove blank line
+	  # remove beginning and end space
+	  create_attr(line.strip.split(@join)) unless line.gsub("\n",'').length == 0
+	end
+      end
+    end
+
+    def method_missing name, *arg
+      # name: _ipaddr=_
+      # if name =~ /[\w]+=$/
+      v = arg.first ?  arg.first : ''
+      create_attr [name.to_s.split('=')[0], v]
+    end
+
+    # TODO
+    def to_s
+      'convert kv to str'
+    end
+
+    private 
+    # ["IPADDR", "192.168.0.201\n"]
+    def create_attr kv
+      save_instance_var kv[0].downcase.to_sym
+      singleton_class.class_eval { attr_accessor kv[0].downcase}
+      send("#{kv[0].downcase}=", kv[1].strip)
+    end
+
+    def save_instance_var var
+      @instance_vars << var
+    end
+
+    # output: @var
+    def prefix_at var
+      "@#{var}"
+    end
+
+    # var: symbol
+    def instance_var_get var
+      instance_variable_get(prefix_at(var))
+    end
+
+    # Ipaddr => ipaddr
+    # ipaddr => IPADDR
+    def convert_case key
+      @case ? key.downcase : key.upcase
+    end
+  end
+end

data/lib/kstarv/version.rb

@@ -0,0 +1,3 @@
+module Kstarv
+  VERSION = "0.0.1"
+end

data/lib/kstarv.rb

@@ -0,0 +1,15 @@
+require "kstarv/version"
+require "kstarv/k_v"
+
+module Kstarv
+  class NoSuchFile < StandardError
+    def message
+      # TODO should say file path to message
+      "can not find _such file_"
+    end
+  end
+
+  def self.from file,join='='
+    File.exists?(file) ? KV.new(file, join) : (raise NoSuchFile)
+  end
+end

data/spec/fixtures/kv

@@ -0,0 +1,11 @@
+DEVICE=eth0
+HWADDR=00:1E:67:24:E8:2D
+TYPE=Ethernet
+UUID=8dc70db4-9c80-4757-807b-6419d864f74d
+ONBOOT=yes
+NM_CONTROLLED=no
+BOOTPROTO=static
+IPADDR=192.168.0.201
+NETMASK=255.255.255.0
+GATEWAY=192.168.0.1
+BORADCAST=192.168.0.255

data/spec/fixtures/kv_1

@@ -0,0 +1,11 @@
+DEVICE=eth0
+HWADDR=00:1E:67:24:E8:2D
+TYPE=Ethernet
+UUID=8dc70db4-9c80-4757-807b-6419d864f74d
+ONBOOT=yes
+NM_CONTROLLED=no
+BOOTPROTO=static
+IPADDR=192.168.0.201
+NETMASK=255.255.255.0
+GATEWAY=192.168.0.1
+BORADCAST=192.168.0.255

data/spec/fixtures/kv_blank_line

@@ -0,0 +1,11 @@
+DEVICE=eth0
+HWADDR=00:1E:67:24:E8:2D
+TYPE=Ethernet
+UUID=8dc70db4-9c80-4757-807b-6419d864f74d
+ONBOOT=yes
+NM_CONTROLLED=no
+BOOTPROTO=static
+IPADDR=192.168.0.201
+NETMASK=255.255.255.0
+GATEWAY=192.168.0.1
+BORADCAST=192.168.0.255

data/spec/fixtures/kv_space

@@ -0,0 +1,11 @@
+DEVICE=eth0
+HWADDR=00:1E:67:24:E8:2D
+TYPE=Ethernet
+UUID=8dc70db4-9c80-4757-807b-6419d864f74d
+ONBOOT=yes
+NM_CONTROLLED=no
+BOOTPROTO=static
+IPADDR=192.168.0.201
+NETMASK=255.255.255.0
+GATEWAY=192.168.0.1
+BORADCAST=192.168.0.255

data/spec/kstarv/k_v_spec.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+require 'spec_helper'
+describe '#KV' do
+  before :each do
+    @file = File.expand_path('../../fixtures/kv_1', __FILE__)
+    @kv = Kstarv::KV.new @file
+  end
+
+  context 'dynamic create attr' do
+    it 'should not including other attr ' do
+      @kv.instance_variable_get(:@instance_vars).should == [:device, :hwaddr, :type, :uuid, :onboot, :nm_controlled, :bootproto, :ipaddr, :netmask, :gateway, :boradcast]
+    end
+    
+    context 'attr do not exists' do
+      after :each do
+        FileUtils.copy File.expand_path('../../fixtures/kv', __FILE__),@file
+      end
+
+      it 'should be empty string' do
+	@kv.chinesename.should == ''
+      end
+
+      it 'should use _method_missing_ method to create attr_accessor' do
+	expect {@kv.chinesename}.not_to raise_error
+      end
+
+      it 'should save config changed' do
+	@kv.chinesename = 'simlegate'
+	@kv.write
+        Kstarv::KV.new(@file).chinesename.should == 'simlegate'
+      end
+    end
+  end
+
+  context 'instance file to object' do
+    it '@instance_vars should be instance of Array' do
+      @kv.instance_variable_get(:@instance_vars).should be_instance_of Array
+    end
+
+    it 'should have 11 attr in fixtures file' do
+      @kv.instance_variable_get(:@instance_vars).count.should == 11
+    end
+
+    it 'element of @instance_vars should be instance of Symbol' do
+      @kv.instance_variable_get(:@instance_vars).map {|var| var.should be_instance_of Symbol}
+    end
+  end
+
+  context 'read config file including blank line' do
+    before :each do
+      @blank_line_file = File.expand_path('../../fixtures/kv_blank_line', __FILE__)
+    end
+
+    it 'should not raise error when instaning' do
+      expect { Kstarv::KV.new @blank_line_file }.not_to raise_error
+    end
+
+    it 'should remove the space at the first of line' do
+      file = File.expand_path('../../fixtures/kv_space', __FILE__)
+      expect { Kstarv::KV.new file }.not_to raise_error
+    end
+  end
+
+  context 'set key case' do
+    it '____' do
+      pending('wait me....')
+    end
+  end
+
+  context 'private method' do
+    it '____' do
+      pending('wait me....')
+    end
+  end
+end

data/spec/kstarv_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'spec_helper'
+describe '#Kstarv' do
+  before :each do
+    @file = File.expand_path('../fixtures/kv_1', __FILE__)
+  end
+
+  it 'should get instance of KV' do
+    Kstarv.from(@file,'=').should be_instance_of Kstarv::KV
+  end
+
+  it 'second param is optional of _from_ method ' do
+    Kstarv.from(@file).should be_instance_of Kstarv::KV
+  end
+
+  it 'should raise error when file do not exists' do
+    @file = File.expand_path('../../fixtures/kv', __FILE__)
+    expect {Kstarv.from(@file,'=')}.to raise_error(Kstarv::NoSuchFile)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require_relative "../lib/kstarv"

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: kstarv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- 都是牛奶装什么特仑苏丶
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrap a Ruby object by parsing text file including key-values
+email:
+- simlegate@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- kstarv.gemspec
+- lib/kstarv.rb
+- lib/kstarv/k_v.rb
+- lib/kstarv/version.rb
+- spec/fixtures/kv
+- spec/fixtures/kv_1
+- spec/fixtures/kv_blank_line
+- spec/fixtures/kv_space
+- spec/kstarv/k_v_spec.rb
+- spec/kstarv_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Wrap a Ruby object by parsing text file including key-values
+test_files:
+- spec/fixtures/kv
+- spec/fixtures/kv_1
+- spec/fixtures/kv_blank_line
+- spec/fixtures/kv_space
+- spec/kstarv/k_v_spec.rb
+- spec/kstarv_spec.rb
+- spec/spec_helper.rb