yapfac 0.1.0 → 0.2.0

data/.travis.yml

@@ -2,3 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
 before_install: gem install bundler -v 1.10.4
+
+addons:
+  code_climate:
+    repo_token: e8fed04b00f6d0616f413bd35be0423670a295988435bd3cf26c5b9c84bd25f9

data/README.md

@@ -1,5 +1,10 @@
 # YAPFAC: Yet Another Parser for Apache Configuration
 
+[![Gem Version](https://badge.fury.io/rb/yapfac.svg)](https://badge.fury.io/rb/yapfac)
+[![Build Status](https://travis-ci.org/eiwi1101/yapfac.svg)](https://travis-ci.org/eiwi1101/yapfac)
+[![Code Climate](https://codeclimate.com/github/eiwi1101/yapfac/badges/gpa.svg)](https://codeclimate.com/github/eiwi1101/yapfac)
+[![Test Coverage](https://codeclimate.com/github/eiwi1101/yapfac/badges/coverage.svg)](https://codeclimate.com/github/eiwi1101/yapfac/coverage)
+
 YAPFAC provides a parser to read and write Apache configuration files. YAPFAC also provides a secure RESTful API for doing this remotely, providing seamless controll of a number of Apache servers.
 
 ## Installation
@@ -7,7 +12,7 @@ YAPFAC provides a parser to read and write Apache configuration files. YAPFAC al
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'yapfac', git: 'eiwi1101/yapfac'
+gem 'yapfac'
 ```
 
 And then execute:
@@ -40,21 +45,33 @@ default = Yapfac::Apache::Site.new("/etc/apache2/sites-available/000-default.con
 puts default.to_s #=> Converts the config back into Apache Config format.
 puts default.to_h #=> Converts the config into a hash.
 
-sites = Yapfac::Apache.sites_available
-puts sites.first.to_s #=> Dumps the configuration file for the first site in sites-available
-
-online = Yapfac::Apache.sites_enabled #=> Just reads the sites-enabled dir.
-
-### COMING SOON
+# This will dump all the sites available to your terminal
+# As the re-generated Apache config and JSON pretty format.
+#
+Yapfac::Apache.sites_available.each do |site|
+  v = Yapfac::Apache.load_site(site)
+
+  puts "=" * 80
+  puts v.name
+  puts "-" * 80
+  puts v.to_s
+  puts "-" * 80
+  puts JSON.pretty_generate v.to_h
+end
 
-Yapfac::Apache.a2ensite  "example.com.conf" #=> Enables site
-Yapfac::Apache.a2dissite "000-default.conf" #=> Disables site
+# This will build and save a new basic site to your sites-available
+# directory.
+#
+s = Yapfac::Apache.new_site('001-example.com') do |site|
+  site.add_directive "DocumentRoot /var/www/example"
 
-# Self-explanatory
-Yapfac::Apache.reload
-Yapfac::Apache.restart
+  site.add_scope "Directory", "/var/www/example" do |scope|
+    scope.add_directive "Order", "allow,deny"
+    scope.add_directive "Allow", "from", "all"
+  end
+end
 
-Yapfac::Apache.a2ensite! "example.com.conf" #=> Enables site and reloads Apache. Same for ::a2dissite.
+s.save #=> Writes output to sites-available
 ```
 
 ## Development
@@ -69,6 +86,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/eiwi1101/yapfac. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
+## Contact
+
+This gem is maintained by William Eisert [weisert@eisertdev.com](mailto:weisert@eisertdev.com).
+
+<a href='https://ko-fi.com?i=15867V22TVFEL' target='_blank'><img style='border:0px;width:140px;' src='https://az743702.vo.msecnd.net/cdn/btn1.png' border='0' alt='Buy me a coffee at ko-fi.com' width="150" /></a> 
 
 ## License
 

data/bin/quicktest

@@ -5,7 +5,7 @@ require 'yapfac'
 require 'json'
 
 Yapfac::Apache.sites_available.each do |site|
-  v = Yapfac::Apache::Site.new(site)
+  v = Yapfac::Apache.load_site(site)
 
   puts "=" * 80
   puts v.name

data/lib/yapfac.rb

@@ -24,5 +24,9 @@ module Yapfac
       @sites_available_path = "sites-available"
       @sites_enabled_path = "sites-enabled"
     end
+
+    def reset!
+      initialize
+    end
   end
 end

data/lib/yapfac/apache.rb

@@ -13,11 +13,24 @@ class Apache
   end
 
   def self.sites_available
-    Dir[File.join(Yapfac.configuration.apache_path, Yapfac.configuration.sites_available_path, '*.conf')]
+    Dir[File.join(Yapfac.configuration.apache_path, Yapfac.configuration.sites_available_path, '*.conf')].collect { |f| File.basename(f, '.conf') }
   end
 
   def self.sites_enabled
-    Dir[File.join(Yapfac.configuration.apache_path, Yapfac.configuration.sites_enabled_path, '*.conf')]
+    Dir[File.join(Yapfac.configuration.apache_path, Yapfac.configuration.sites_enabled_path, '*.conf')].collect { |f| File.basename(f, '.conf') }
+  end
+
+  def self.load_site(site_name)
+    file = File.join(Yapfac.configuration.apache_path, Yapfac.configuration.sites_available_path, site_name + '.conf')
+
+    return nil unless File.exists? file
+    return Yapfac::Apache::Site.load(file)
+  end
+
+  def self.new_site(site_name)
+    site = Yapfac::Apache::Site.new(site_name)
+    yield  site
+    return site
   end
 
 end

data/lib/yapfac/apache/directive.rb

@@ -4,11 +4,51 @@ class  Directive
 
   attr_accessor :name, :params
 
-  def initialize(name, params = nil)
+  # Initialize a new Directive, given an array and arbitrary number of params.
+  #
+  # @param [String] name    The directive name (DocumentRoot, etc.)
+  # @param [Array]  *params Any number of parameters for the directive.
+  #
+  def initialize(name, *params)
     @name   = name
-    @params = parse(params)
+    @params = params
   end
 
+  # Parses a directive string into a directive object. This is most often used
+  # when reading in from a file.
+  #
+  # @param [String] name   The directive name (DocumentRoot, etc.)
+  # @param [String] params A string of directive parameters to parse.
+  #
+  # @overload parse(line)
+  #   @param [String] line The full directive line to parse, with or without
+  #                   params.
+  #
+  # @return [Yapfac::Apache::Directive] New and parsed directive instance.
+  #
+  # @example Known Name
+  #   d = Yapfac::Apache::Directive.parse("DocumentRoot", "/www/html")
+  #
+  # @example Full Line Parse
+  #   d = Yapfac::Apache::Directive.parse("DocumentRoot /www/html")
+  #
+  # @example Parse Multiple Params
+  #   # The real purpose of this method.
+  #   d1 = Yapfac::Apache::Directive.parse("Deny from all")
+  #   d2 = Yapfac::Apache::Directive.parse("Deny", "from all")
+  #
+  #   # d1.params == d2.params == ["from", "all"]
+  #
+  def self.parse(name, params = nil)
+    name, params = name.split /\s+/, 2 if params.nil?
+    return Yapfac::Apache::Directive.new(name, *parse_params(params))
+  end
+
+  # Builds a string representation of the directive, which is valid for
+  # storing in an Apache configuration file.
+  #
+  # @return [String] String representation of Apache Directive
+  #
   def to_s
     "#{@name} #{@params.collect do |p|
       if p =~ /\s/
@@ -19,6 +59,15 @@ class  Directive
     end.join(' ')}"
   end
 
+  # Builds a hash representation of the Apache Directive, useful for
+  # serialization.
+  #
+  # @return [Hash] A hash with +:name+ (String) and +:params+ (array) keys.
+  #
+  # @example Hashify an Apache Directive
+  #   d = Yapfac::Apache::Directive.parse("Deny from all")
+  #   d.to_h #=> { name: "Deny", params: [ "from", "all" ] }
+  #
   def to_h
     return ({
       name: @name,
@@ -28,7 +77,11 @@ class  Directive
 
 private
 
-  def parse(params)
+  # Tokenizes params, keeping quoted values together.
+  # @param [String] params Params string to tokenize
+  # @return [Array] Tokenized params
+  #
+  def self.parse_params(params = nil)
     return Array.new if params.nil?
 
     return params.

data/lib/yapfac/apache/scope.rb

@@ -2,7 +2,12 @@ module Yapfac
 class  Apache
 class  Scope
 
-  attr_reader :name, :params, :parent
+  attr_reader :directives
+  attr_reader :scopes
+
+  attr_accessor :parent
+  attr_accessor :name
+  attr_accessor :params
 
   def initialize(name = nil, params = nil, parent = nil)
     @name   = name
@@ -13,16 +18,30 @@ class  Scope
     @scopes     = Array.new
   end
 
-  def add_directive(line)
-    @directives.push(line)
+  def add_directive(directive, *params)
+    if directive.kind_of? Yapfac::Apache::Directive
+      @directives.push(directive)
+    else
+      @directives.push(Yapfac::Apache::Directive.new(directive, *params))
+    end
   end
 
-  def add_scope(scope)
-    if scope == self
-      raise "Scope can not be a child of itsself."
+  def add_scope(scope, *params)
+    if scope.kind_of? Yapfac::Apache::Scope
+      if scope == self
+        raise "Scope can not be a child of itsself."
+      end
+
+      scope.parent = self
+      @scopes.push(scope)
+    else
+      scope = Yapfac::Apache::Scope.new(scope, *params, self)
+      @scopes.push(scope)
     end
 
-    @scopes.push(scope)
+    if block_given?
+      yield scope
+    end
   end
 
   def to_h
@@ -40,7 +59,7 @@ class  Scope
     out = Array.new
     tab = @parent.nil? ? "" : "\t"
 
-    unless parent.nil?
+    unless self.kind_of? Yapfac::Apache::Site
       out << "<#{@name} #{@params.join(' ')}>"
     end
 
@@ -52,7 +71,7 @@ class  Scope
       out << @scopes.collect { |s| s.to_s.split("\n").collect { |v| v.prepend(tab) }.join("\n") }
     end
 
-    unless parent.nil?
+    unless self.kind_of? Yapfac::Apache::Site
       out << "</#{@name}>"
     end
 

data/lib/yapfac/apache/site.rb

@@ -2,25 +2,36 @@ module Yapfac
 class  Apache
 class  Site < Scope
 
-  def initialize(filename)
-    super()
-    @name = File.basename(filename, '.conf')
-    @config_lines = read_file(filename)
-    parse!
+  attr_reader :config_lines
+
+  def initialize(site_name)
+    super(site_name)
   end
 
-private
+  def self.load(filename)
+    s = Yapfac::Apache::Site.new(File.basename(filename, '.conf'))
+    s.load_file(filename)
+    s.parse!
+    return s
+  end
 
-  def read_file(filename)
-    lines = File.read(filename)
-    lines.gsub!("\\\n", '')
+  def filename
+    File.join(Yapfac.configuration.apache_path, Yapfac.configuration.sites_available_path, @name + '.conf')
+  end
 
-    lines_a = lines.split("\n").map(&:strip!)
-    lines_a.reject! { |l| l =~ /^\s*(?:#.*)?$/ }
+  def save
+    File.write(filename, to_s)
+  end
+
+  def load_file(filename)
+    lines = File.read(filename)
+    lines.gsub!("\\\n", ' ')
+    lines_a = lines.split("\n").map(&:strip)
+    lines_a.reject! { |l| l =~ /^\s*#.*$/ }
     lines_a.reject! &:nil?
     lines_a.map     { |l| l.gsub! /\s+/, ' ' }
 
-    return lines_a
+    @config_lines = lines_a
   end
 
   def parse!
@@ -39,7 +50,7 @@ private
 
       # Add Directive
       elsif line =~ /^(\w+)\s*(.*)$/
-        directive = Yapfac::Apache::Directive.new($1, $2)
+        directive = Yapfac::Apache::Directive.parse($1, $2)
         scope.add_directive(directive)
       end
     end

data/lib/yapfac/version.rb

@@ -1,3 +1,3 @@
 module Yapfac
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/yapfac.gemspec

@@ -22,4 +22,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-collection_matchers"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "codeclimate-test-reporter"
+
+  spec.add_dependency "sinatra"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yapfac
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - William Eisert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+date: 2016-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,62 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  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: fuubar
+  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: codeclimate-test-reporter
+  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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Parsing and manipulation gem for Apache configuration files. Can also
   be used to control remote servers using a secure RESTful API. Think, Webmin.
 email:
@@ -60,8 +116,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .codeclimate.yml
 - .gitignore
 - .rspec
+- .rubocop.yml
 - .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -103,3 +161,4 @@ signing_key:
 specification_version: 4
 summary: Yet Another Parser for Apache Configuration
 test_files: []
+has_rdoc: