hosts 0.1.0

data/hosts.gemspec

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2012
+
+This file is part of Hosts.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require File.expand_path('../lib/aef/hosts/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'hosts'
+  s.version     = Aef::Hosts::VERSION.dup
+  s.authors     = ['Alexander E. Fischer']
+  s.email       = ['aef@raxys.net']
+  s.homepage    = 'http://github.com/aef/hosts'
+  s.license     = 'ISC'
+  s.summary     = 'Host file manipulation for Ruby.'
+  s.description = <<-DESCRIPTION
+Hosts is a Ruby library able to read or manipulate the operating system's host
+files. When manipulating it tries to preserve their original formatting.
+  DESCRIPTION
+
+  s.rubyforge_project = nil
+  s.has_rdoc          = 'yard'
+  s.extra_rdoc_files  = ['HISTORY.md', 'LICENSE.md'] 
+
+  s.files         = `git ls-files`.lines.map(&:chomp)
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.lines.map(&:chomp)
+  s.executables   = `git ls-files -- bin/*`.lines.map{|f| File.basename(f.chomp) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.add_dependency('linebreak', '~> 2.0.0')
+
+  s.add_development_dependency('bundler', '~> 1.1.0')
+  s.add_development_dependency('rake', '~> 0.9.2')
+  s.add_development_dependency('rspec', '~> 2.8.0')
+  s.add_development_dependency('simplecov', '~> 0.6.1')
+  s.add_development_dependency('pry', '~> 0.9.8')
+  s.add_development_dependency('yard', '~> 0.7.5')
+
+  s.cert_chain = "#{ENV['GEM_CERT_CHAIN']}".split(':')
+  s.signing_key = ENV['GEM_SIGNING_KEY']
+end

data/lib/aef/hosts.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2012
+
+This file is part of Hosts.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'set'
+require 'pathname'
+require 'aef/linebreak'
+
+# Namespace for projects of Alexander E. Fischer <aef@raxys.net>.
+#
+# If you want to be able to simply type Example instead of Aef::Example to
+# address classes in this namespace simply write the following before using the
+# classes.
+#
+# @example Including the namespace
+#   include Aef
+# @author Alexander E. Fischer
+module Aef
+
+  # Namespace for the hosts library
+  module Hosts
+
+    # An exception for errors happening while parsing a hosts file
+    class ParserError < RuntimeError; end
+  end
+end
+
+require 'aef/hosts/version'
+require 'aef/hosts/helpers'
+require 'aef/hosts/file'
+require 'aef/hosts/element'
+require 'aef/hosts/section'
+require 'aef/hosts/entry'
+require 'aef/hosts/comment'
+require 'aef/hosts/empty_element'
+

data/lib/aef/hosts/comment.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2012
+
+This file is part of Hosts.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'aef/hosts'
+
+module Aef
+  module Hosts
+
+    # Represents a comment-only line as element of a hosts file
+    class Comment < Element
+      
+      # The comment
+      #
+      # @return [String]
+      attr_reader :comment
+
+      # Initializes a comment
+      #
+      # @param comment [String] the comment
+      # @param options [Hash]
+      # @option options [String] :cache sets a cached String representation
+      def initialize(comment, options = {})
+        validate_options(options, :cache)
+        
+        raise ArgumentError, 'Comment cannot be empty' unless comment
+
+        @comment = comment.to_s
+        @cache   = options[:cache].to_s unless options[:cache].nil?
+      end
+
+      # Sets the comment
+      def comment=(comment)
+        set_if_changed(:comment, comment.to_s) do
+          invalidate_cache!
+        end
+      end
+
+      # A String representation for debugging purposes
+      #
+      # @return [String]
+      def inspect
+        generate_inspect(self, :comment, :cache)
+      end
+
+      protected
+
+      # Defines the algorithm to generate a String representation from scratch.
+      #
+      # @return [String] a generated String representation
+      def generate_string(options = {})
+        "##{comment}\n"
+      end
+    end
+
+  end
+end
+

data/lib/aef/hosts/element.rb

@@ -0,0 +1,108 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2012
+
+This file is part of Hosts.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'aef/hosts'
+
+module Aef
+  module Hosts
+
+    # The base class for elements which are aggregated by the Aef::Hosts::File
+    # class.
+    #
+    # @abstract This class is not supposed to be instantiated.
+    class Element
+
+      include Helpers
+
+      # Cached String representation
+      #
+      # @return [String, Hash, nil]
+      attr_reader :cache
+
+      # Deletes the cached String representation
+      #
+      # @return [Aef::Hosts::Element] a self reference
+      def invalidate_cache!
+        @cache = nil
+
+        self
+      end
+
+      # Tells if a String representation is cached or not
+      #
+      # @return [true, false] true if cache is not empty
+      def cache_filled?
+        @cache ? true : false
+      end
+
+      # A String representation for debugging purposes
+      #
+      # @return [String]
+      def inspect
+        generate_inspect(self, :cache)
+      end
+
+      # Provides a String representation of the element
+      #
+      # @param [Hash] options
+      # @option options [true, false] :force_generation if set to true, the
+      #   cache won't be used, even if it not empty
+      # @option options [:unix, :windows, :mac] :linebreak_encoding the
+      #   linebreak encoding of the result. If nothing is specified the result
+      #   will be encoded as if :unix was specified.
+      # @see Aef::Linebreak#encode
+      def to_s(options = {})
+        validate_options(options, :force_generation, :linebreak_encoding)
+
+        string = ''
+
+        if !cache_filled? || options[:force_generation]
+          string << generate_string(options)
+        else
+          string << cache_string(options)
+        end
+
+        if options[:linebreak_encoding]
+          string = Aef::Linebreak.encode(string, options[:linebreak_encoding])
+        end
+
+        string
+      end
+
+      protected
+
+      # Defines the algorithm to generate a String representation from scratch.
+      #
+      # @abstract This method needs to be implemented in descendant classes.
+      # @return [String] a generated String representation
+      def generate_string(options = {})
+        raise NotImplementedError
+      end
+
+      # Defines the algorithm to construct the String representation from cache
+      #
+      # @return [String] the cached String representation
+      def cache_string(options = {})
+        @cache.dup
+      end
+    end
+
+  end
+end
+

data/lib/aef/hosts/empty_element.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2012
+
+This file is part of Hosts.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'aef/hosts'
+
+module Aef
+  module Hosts
+
+    # Represents an empty line as element of a hosts file
+    class EmptyElement < Element
+
+      # Initializes an empty Element
+      #
+      # @param [Hash] options
+      # @option options [String] :cache sets a cached String representation
+      def initialize(options = {})
+        validate_options(options, :cache)
+
+        @cache = options[:cache].to_s unless options[:cache].nil?
+      end
+
+      protected
+
+      # Defines the algorithm to generate a String representation from scratch.
+      #
+      # @return [String] a generated String representation
+      def generate_string(options = {})
+        "\n"
+      end
+
+    end
+  end
+end
+

data/lib/aef/hosts/entry.rb

@@ -0,0 +1,123 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2012
+
+This file is part of Hosts.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'aef/hosts'
+
+module Aef
+  module Hosts
+
+    # Represents an entry line as element of a hosts file
+    class Entry < Element
+      
+      # The network address
+      #
+      # @return [String]
+      attr_reader :address
+
+      # The primary hostname for the address
+      #
+      # @return [String]
+      attr_reader :name
+
+      # Optional comment
+      #
+      # @return [String]
+      attr_reader :comment
+
+      # Optional alias hostnames
+      #
+      # @return [Array<String>]
+      attr_reader :aliases
+
+      # Initializes an entry.
+      #
+      # @param [String] address the network address
+      # @param [String] name the primary hostname for the address
+      # @param [Hash] options
+      # @option options [Array<String>] :aliases a list of aliases for the
+      #   address
+      # @option options [String] :comment a comment for the entry
+      # @option options [String] :cache a cached String representation
+      def initialize(address, name, options = {})
+        validate_options(options, :aliases, :comment, :cache)
+
+        raise ArgumentError, 'Address cannot be empty' unless address
+        raise ArgumentError, 'Name cannot be empty' unless name
+
+        @address = address.to_s
+        @name    = name.to_s
+        @aliases = options[:aliases] || []
+        @comment = options[:comment].to_s unless options[:comment].nil?
+        @cache   = options[:cache].to_s unless options[:cache].nil?
+      end
+
+      # Sets the network address
+      def address=(address)
+        set_if_changed(:address, address.to_s) do
+          invalidate_cache!
+        end
+      end
+
+      # Sets the primary hostname for the address
+      def name=(name)
+        set_if_changed(:name, name.to_s) do
+          invalidate_cache!
+        end
+      end
+
+      # Sets the optional comment
+      def comment=(comment)
+        set_if_changed(:comment, comment.to_s) do
+          invalidate_cache!
+        end
+      end
+
+      # Sets the optional alias hostnames
+      def aliases=(aliases)
+        set_if_changed(:aliases, [*aliases]) do
+          invalidate_cache!
+        end
+      end
+
+      # A String representation for debugging purposes
+      #
+      # @return [String]
+      def inspect
+        generate_inspect(self, :address, :name, :aliases, :comment, :cache)
+      end
+
+      protected
+
+      # Defines the algorithm to generate a String representation from scratch.
+      #
+      # @abstract This method needs to be implemented in descendant classes.
+      # @return [String] a generated String representation
+      def generate_string(options = nil)
+        if comment
+          suffix = " ##{comment}\n"
+        else
+          suffix = "\n"
+        end
+
+        [address, name, *aliases].join(' ') << suffix
+      end
+
+    end
+  end
+end