deb822 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d5b7765d6312156bdb4820387131595ad8c771f9b1ac016d14bba4bc1145210
+  data.tar.gz: f77ff567e85b3ed139a9f22bbd3a33f2409bad5b04f2326186e7254dc002be7d
+SHA512:
+  metadata.gz: 5f4ea00dd8a05cdd2a787e7c13407c7058ce804fd1d80d9da492da69e93793db4eabcc8f3433a1734434862f979f879089a4b9f1f65cae25a976c9c7e5532006
+  data.tar.gz: 9144a441e5eb32eff725dd48473027a8e8a18502b10b9cc71b6f90e5ad21215abc990227f3008248afb0593a3fcca0af3ef4b185d0f479ac0b4c664db86b07dc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    deb822 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  deb822!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kasumi Hanazuki
+
+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,3 @@
+# Deb822
+
+Parser and generator for [deb822(5)](https://manpages.debian.org/unstable/dpkg-dev/deb822.5.en.html).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/deb822.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'deb822'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Kasumi Hanazuki']
+  spec.email         = ['kasumi@rollingapple.net']
+
+  spec.summary       = %q{deb822 parser}
+  spec.description   = %q{Parser for Debian control files}
+  spec.homepage      = 'https://github.com/hanazuki/ruby-deb822'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split(?\0).reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/deb822.rb

@@ -0,0 +1,106 @@
+require 'forwardable'
+
+module Deb822
+  class Error < StandardError; end
+  class FormatError < Deb822::Error; end
+  class InvalidFieldName < FormatError; end
+
+  singleton_class.define_method(:FieldName) do |name|
+    if name.is_a?(FieldName)
+      name
+    else
+      FieldName.new(name)
+    end
+  end
+
+  class FieldName
+
+    # > The field name is composed of US-ASCII characters excluding control characters, space, and colon
+    # > (i.e., characters in the ranges U+0021 ‘!’ through U+0039 ‘9’, and U+003B ‘;’ through U+007E ‘~’, inclusive).
+    # > Field names must not begin with the comment character (U+0023 ‘#’), nor with the hyphen character (U+002D ‘-’).
+    PATTERN = /[!"$-,.-9;-~][!-9;-~]*/
+
+    def initialize(name)
+      name = name.to_s unless name.is_a?(String)
+
+      unless /\A#{PATTERN}\z/o.match?(name)
+        raise InvalidFieldName, "Invalid field name: #{name.inspect}"
+      end
+
+      @sym = FieldName.canonicalize(name).to_sym
+    end
+
+    def to_sym
+      @sym
+    end
+
+    def to_s
+      @sym.to_s
+    end
+
+    def hash
+      @sym.hash
+    end
+
+    def eql?(other)
+      to_sym == Deb822::FieldName(other).to_sym
+    end
+
+    def ==(other)
+      eql?(other)
+    end
+
+    def !=(other)
+      !eql?(other)
+    end
+
+    def inspect
+      @sym
+    end
+
+    def self.canonicalize(str)
+      str.split(?-).each {|s| s.capitalize!(:ascii) }.join(?-)
+    end
+  end
+
+  # Hash-like structure whose keys are FieldName.
+  class Paragraph
+    extend Enumerable
+    extend Forwardable
+
+    def initialize(hash = nil)
+      @hash = {}
+      update(hash) if hash
+    end
+
+    def [](key)
+      @hash[Deb822::FieldName(key)]
+    end
+
+    def []=(key, value)
+      @hash[Deb822::FieldName(key)] = value.to_s
+    end
+    alias :store :[]=
+
+    def fetch(key, *default, &block)
+      @hash.fetch(Deb822::FieldName(key), *default, &block)
+    end
+
+    def update(other)
+      other.each do |k, v|
+        store(k, v)
+      end
+    end
+
+    def slice(*keys)
+      Paragraph.new(@hash.slice(*keys.map(&Deb822.method(:FieldName))))
+    end
+
+    def_delegators :@hash,
+      :each, :each_pair, :each_key, :each_value,
+      :empty?, :length, :size,
+      :keys, :has_key?, :include?, :key?, :member?,
+      :values, :values_at, :has_value?, :value?,
+      :inspect, :to_h, :to_hash, :to_proc
+  end
+end

data/lib/deb822/emitter.rb

@@ -0,0 +1,67 @@
+require 'deb822'
+
+module Deb822
+  # Low-level generator for deb822 document
+  class Emitter
+    def initialize(output)
+      @output = output
+
+      @at_beginning = true
+      @in_paragraph = false
+    end
+
+    def emit_field(name, value)
+      name = Deb822.FieldName(name)
+
+      if value.respond_to?(:each_line)
+        enum = value.each_line
+      else
+        enum = value.to_s.each_line
+      end
+
+      if !@at_beginning && !@in_paragraph
+        @output << "\n"
+      end
+      @at_beginning = false
+      @in_paragraph = true
+
+      @output << name.to_s << ': '
+
+      begin
+        line = enum.next
+        @output << line
+        @output << "\n" unless line.end_with?("\n")
+      rescue StopIteration
+        # nop
+      else
+        loop do
+          emit_continuation_line(enum.next)
+        end
+      end
+
+      self
+    end
+
+    def emit_fields(pairs)
+      pairs.each_pair do |name, value|
+        emit_field(name, value)
+      end
+    end
+
+    def emit_continuation_line(line)
+      if /\A(?:\.|\Z)/.match?(line)
+        @output << ' .' << line
+      else
+        @output << ' ' << line
+      end
+      @output << "\n" unless line.end_with?("\n")
+      self
+    end
+
+    def start_paragraph
+      @in_paragraph = false
+      self
+    end
+    alias :end_paragraph :start_paragraph
+  end
+end

data/lib/deb822/parser.rb

@@ -0,0 +1,38 @@
+require 'deb822'
+require 'deb822/scanner'
+
+module Deb822
+  # High-level parser for deb822 documents
+  class Parser
+    def initialize(input)
+      @scanner = Scanner.new(input)
+    end
+
+    def each_paragraph
+      return to_enum(:each_paragraph) unless block_given?
+
+      last_par = last_val = nil
+
+      @scanner.each_line do |l|
+        case l[0]
+        when :paragraph_separator
+          yield last_par if last_par
+          last_par = last_val = nil
+        when :comment
+          next
+        when :field
+          last_par ||= Paragraph.new
+          last_par[l[1]] = last_val = l[2]
+        when :continuation
+          last_val << "\n" unless last_val.end_with?("\n")
+          last_val << l[1]
+        else
+          fail "BUG: unreachable code: #{l.inspect}"
+        end
+      end
+
+      yield last_par if last_par
+    end
+    alias :paragraphs :each_paragraph
+  end
+end

data/lib/deb822/scanner.rb

@@ -0,0 +1,64 @@
+require 'deb822'
+require 'stringio'
+
+module Deb822
+  # Low-level parser for deb822 documents
+  class Scanner
+    def initialize(input)
+      @input = input.is_a?(String) ? StringIO.new(input) : input
+
+      @in_paragraph = false
+    end
+
+    WS = /[ \t]/
+
+    def next_line
+      loop do
+        begin
+          line = @input.readline
+        rescue EOFError
+          break
+        end
+
+        case line
+        when /\A#{WS}*\Z/o
+          # > The paragraphs are separated by empty lines.
+          # > Parsers may accept lines consisting solely of U+0020 SPACE and U+0009 TAB as paragraph separators
+          if @in_paragraph
+            @in_paragraph = false
+            break [:paragraph_separator]
+          else
+            next
+          end
+        when /\A#/
+          # > Lines starting with U+0023 ‘#’, without any preceding whitespace are comments lines
+          break [:comment, $']
+        when /\A(#{FieldName::PATTERN}):#{WS}*/o
+          name = $1
+          value = $'.chomp
+          @in_paragraph = true
+          break [:field, name, value]
+        when /\A#{WS}\.?/o
+          # > The lines after the first are called continuation lines and must start with a U+0020 SPACE or a U+0009 TAB.
+          # > Empty lines in field values are usually escaped by representing them by a U+0020 SPACE followed
+          # > by a dot (U+002E ‘.’).
+          raise FormatError, "Unexpected continuation line: #{line.inspect}" unless @in_paragraph
+          break [:continuation, $']
+        else
+          raise FormatError, "Ill-formed line: #{line.inspect}"
+        end
+
+        return nil
+      end
+    end
+
+    def each_line
+      return to_enum(:each_line) unless block_given?
+
+      while l = next_line
+        yield l
+      end
+    end
+    alias :lines :each_line
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: deb822
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasumi Hanazuki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-04 00:00:00.000000000 Z
+dependencies: []
+description: Parser for Debian control files
+email:
+- kasumi@rollingapple.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- deb822.gemspec
+- lib/deb822.rb
+- lib/deb822/emitter.rb
+- lib/deb822/parser.rb
+- lib/deb822/scanner.rb
+homepage: https://github.com/hanazuki/ruby-deb822
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hanazuki/ruby-deb822
+  source_code_uri: https://github.com/hanazuki/ruby-deb822
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: deb822 parser
+test_files: []