deb_control 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8756498877b70f0be2440e409f3bbd1412f92750
+  data.tar.gz: b9616abf04b84e749ee2de4d984c2eab3e60721d
+SHA512:
+  metadata.gz: e7dd18e61c91721633bbaadda341a2744cd5aba3aa8e218934bf200a148d0ad68de0830a83f560fac66191c4506710dcb4e09e5ae5a6c0d36892021b346e72ea
+  data.tar.gz: 803f2373ebfe00a10cfde4e6735775a95b76e29559a4243d2ad3da00f05a840f6601a45afcf535a745ff8715629a1acf0534385cb59e882d86a0d8ad36e14d25

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.idea
+*.iml
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'coveralls', require: false
+end
+
+# Specify your gem's dependencies in deb_control.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Malte Swart
+
+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,48 @@
+# DebControl
+
+[![Gem Version](https://badge.fury.io/rb/deb_control.png)](http://badge.fury.io/rb/deb_control)
+[![Build Status](https://travis-ci.org/mswart/deb_control.png?branch=master)](https://travis-ci.org/mswart/deb_control)
+[![Coverage Status](https://coveralls.io/repos/mswart/deb_control/badge.png?branch=master)](https://coveralls.io/r/mswart/deb_control)
+[![Code Climate](https://codeclimate.com/github/mswart/deb_control.png)](https://codeclimate.com/github/mswart/deb_control)
+
+DebControl contains helper classes to read Debian control files. Write support is planed.
+
+**This gem is under development. Every 0.x release might break backwards compatibility.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deb_control', '~> 0.0.1'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deb_control
+
+
+## Usage
+
+The Class DebControl::ControlFileBase implements a generic parser for control files:
+
+```ruby
+control = DebControl::ControlFileBase.read 'debian/control'
+# receive the array from paragraphs:
+control.paragraphs.size
+# receive fields of paragraph:
+control.paragraphs.first['Source']
+```
+
+Each paragraph is a Hash containing its fields and values.
+
+
+## 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,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/deb_control.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deb_control/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deb_control'
+  spec.version       = DebControl::VERSION
+  spec.authors       = ['Malte Swart']
+  spec.email         = %w(mswart@devtation.de)
+  spec.description   = 'Helpers to read debian control files'
+  spec.summary       = File.read('README.md')
+  spec.homepage      = 'https://github.com/mswart/deb_control'
+  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 = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/deb_control.rb

@@ -0,0 +1,5 @@
+require 'deb_control/version'
+require 'deb_control/control_file_base'
+
+module DebControl
+end

data/lib/deb_control/control_file_base.rb

@@ -0,0 +1,76 @@
+module DebControl
+  # Generic parser class for control files. It is design to be used as parent classes for specific
+  # files like the debian source control file.
+  #
+  # @api public
+  class ControlFileBase
+    # @api public
+    # @param [String] filecontent A string with all data that should be parsed
+    # @return [Array<Hash<String, String>>] The parsed data: a array of paragraphs. Each paragraph
+    #   is a Hash contain its field value pairs.
+    def self.parse(filecontent)
+      parsed = []
+      current_paragraph = []
+      filecontent.split("\n").each do |line|
+        if line.strip == ''
+          parsed << parse_paragraph(current_paragraph)
+          current_paragraph = []
+        else
+          current_paragraph << line
+        end
+      end
+
+      if current_paragraph.size > 0
+        parsed << parse_paragraph(current_paragraph)
+      end
+      parsed
+    end
+
+
+    # @api private
+    # @param [Array<String>] lines all lines of the paragraph
+    # @return [Hash<String, String>] parsed key value pairs
+    #
+    def self.parse_paragraph(lines)
+      fields = {}
+      field = nil
+      value = nil
+      lines.each do |line|
+        if line.include? ':'  # no value
+          unless field.nil?
+            fields[field] = value
+          end
+          field, value = line.split ':', 2
+          value.strip!
+        elsif line =~ /^\s/
+          value += "\n" + line.strip
+        else
+          # error
+        end
+      end
+      unless field.nil?
+        fields[field] = value
+      end
+      fields
+    end
+
+    # Create a new ControlFileBase instances with the contain of the given file name.
+    #
+    # @api public
+    # @param [String] filename A relative or absolute file name to the file that should be parsed.
+    # @return [ControlFileBase] A new object instance contain the parsed data. Use the paragraphs
+    #   accessor to use them.
+    # @example
+    #   control = ControlFileBase.read 'debian/control'
+    #   puts control.paragraphs.first['Source']
+    def self.read(filename)
+      new parse File.read filename
+    end
+
+    def initialize(paragraphs)
+      @paragraphs = paragraphs
+    end
+
+    attr_reader :paragraphs
+  end
+end

data/lib/deb_control/version.rb

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

data/spec/deb_control/control_file_base_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe DebControl::ControlFileBase do
+  subject { DebControl::ControlFileBase }
+  describe '#parse' do
+    let(:single) do
+      <<-EOF
+Field1: b
+Field2: c
+      EOF
+    end
+    let(:multiple) do
+      <<-EOF
+Field1: c
+Field3: b
+
+Field6: 9
+Field7: b
+      EOF
+    end
+    let(:multiple_with_space) do
+      <<-EOF
+Field1: c
+Field3: b
+EOF + '  ' + <<-EOF
+Field6: 9
+Field7: b
+      EOF
+    end
+
+    context 'paragraph splitting' do
+      it 'parse paragraph' do
+        expect(subject).to receive(:parse_paragraph).with(['Field1: b', 'Field2: c']).ordered
+        expect(subject.parse(single).size).to eq 1
+      end
+
+      it 'parse multiple paragraphs separately' do
+        expect(subject).to receive(:parse_paragraph).with(['Field1: c', 'Field3: b']).ordered
+        expect(subject).to receive(:parse_paragraph).with(['Field6: 9', 'Field7: b']).ordered
+        expect(subject.parse(multiple).size).to eq 2
+      end
+
+      it 'parse multiple paragraphs separated by line with spaces' do
+        expect(subject).to receive(:parse_paragraph).with(['Field1: c', 'Field3: b']).ordered
+        expect(subject).to receive(:parse_paragraph).with(['Field6: 9', 'Field7: b']).ordered
+        expect(subject.parse(multiple).size).to eq 2
+      end
+    end
+
+    context 'high level' do
+      it 'parse paragraphs and fields' do
+        parsed = subject.parse multiple
+        expect(parsed.size).to eq 2
+        expect(parsed[0]).to eq({'Field1' => 'c', 'Field3' => 'b'})
+        expect(parsed[1]).to eq({'Field6' => '9', 'Field7' => 'b'})
+      end
+    end
+  end
+
+  describe '#parse_paragraph' do
+    it 'single value without space' do
+      expect(subject.parse_paragraph(['Field:value'])).to eq({ 'Field' => 'value' })
+    end
+
+    it 'single value' do
+      expect(subject.parse_paragraph(['Field: value'])).to eq({ 'Field' => 'value' })
+    end
+
+    it 'single value with trailing space' do
+      expect(subject.parse_paragraph(['Field: value  '])).to eq({ 'Field' => 'value' })
+    end
+
+    it 'value with colon' do
+      expect(subject.parse_paragraph(['Field: v:alue'])).to eq({ 'Field' => 'v:alue' })
+    end
+
+    it 'two values' do
+      values = subject.parse_paragraph(['Field: v:alue', 'Key: data'])
+      expect(values).to eq({ 'Field' => 'v:alue', 'Key' => 'data' })
+      expect(values.keys).to eq ['Field', 'Key']
+    end
+
+    it 'multi-line values' do
+      values = subject.parse_paragraph(['Field: first-line', ' second-line'])
+      expect(values).to eq({ 'Field' => "first-line\nsecond-line"})
+    end
+  end
+
+  describe '#read' do
+    let(:filename) { File.expand_path '../../fixtures/simple_control_file.txt', __FILE__ }
+
+    it 'should parse the file' do
+      parsed = subject.read filename
+      expect(parsed).to be_instance_of subject
+      expect(parsed.paragraphs.size).to eq 2
+      expect(parsed.paragraphs.first['Field1']).to eq 'c'
+    end
+  end
+end

data/spec/fixtures/simple_control_file.txt

@@ -0,0 +1,5 @@
+Field1: c
+Field3: b
+
+Field6: 9
+Field7: b

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'coveralls'
+Coveralls.wear! do
+  add_filter 'spec'
+end
+
+require 'deb_control'
+
+Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.expect_with :rspec do |c|
+    # Only allow expect syntax
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: deb_control
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Malte Swart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-30 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: 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: Helpers to read debian control files
+email:
+- mswart@devtation.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deb_control.gemspec
+- lib/deb_control.rb
+- lib/deb_control/control_file_base.rb
+- lib/deb_control/version.rb
+- spec/deb_control/control_file_base_spec.rb
+- spec/fixtures/simple_control_file.txt
+- spec/spec_helper.rb
+homepage: https://github.com/mswart/deb_control
+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.3
+signing_key: 
+specification_version: 4
+summary: '# DebControl  [![Gem Version](https://badge.fury.io/rb/deb_control.png)](http://badge.fury.io/rb/deb_control)
+  [![Build Status](https://travis-ci.org/mswart/deb_control.png?branch=master)](https://travis-ci.org/mswart/deb_control)
+  [![Coverage Status](https://coveralls.io/repos/mswart/deb_control/badge.png?branch=master)](https://coveralls.io/r/mswart/deb_control)
+  [![Code Climate](https://codeclimate.com/github/mswart/deb_control.png)](https://codeclimate.com/github/mswart/deb_control)  DebControl
+  contains helper classes to read Debian control files. Write support is planed.  **This
+  gem is under development. Every 0.x release might break backwards compatibility.**  ##
+  Installation  Add this line to your application''s Gemfile:  gem ''deb_control'',
+  ''~> 0.0.1''  And then execute:  $ bundle  Or install it yourself as:  $ gem install
+  deb_control   ## Usage  The Class DebControl::ControlFileBase implements a generic
+  parser for control files:  ```ruby control = DebControl::ControlFileBase.read ''debian/control''
+  # receive the array from paragraphs: control.paragraphs.size # receive fields of
+  paragraph: control.paragraphs.first[''Source''] ```  Each paragraph is a Hash containing
+  its fields and values.   ## 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'
+test_files:
+- spec/deb_control/control_file_base_spec.rb
+- spec/fixtures/simple_control_file.txt
+- spec/spec_helper.rb