wordpress_config_parser 0.9.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Keith Bennett
+
+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,136 @@
+# WordpressConfigParser
+
+Reads a Wordpress configuration file (wp-config.php) and
+makes its define() data values easily accessible.
+
+This is useful, for example, in the creation of a mysqldump command
+without having to store config information (especially passwords) in a second place, to avoid
+wasted effort, risk of stale data, and password compromise.
+
+The parsing algorithm is extremely primitive, but "works for me".
+
+The WCParser constructor will handle any of the following as its argument:
+
+* an array of lines
+* a filespec of a Wordpress config file
+* a filespec of a directory containing a Wordpress config file
+  ('wp-config.php' is assumed to be the file's name).
+
+After instantiating a parser, you can access the variables defined
+in the config file in the following ways:
+
+```ruby
+
+parser = WCParser.new('/Users/me/public_html/blog')
+
+db_name = parser.db_name
+# or
+db_name = parser['DB_NAME']
+# or
+db_name = parser[:db_name]
+# or
+db_name = parser.get(:db_name)
+# or
+db_name = parser.get('DB_NAME')
+```
+
+Here's an example of a possibly useful script that creates a sql backup
+of multiple blogs on a shared host, adds them to the git repo (of the
+entire shell account), and pushes them to the origin repo:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'wordpress_config_parser'
+require 'shellwords'
+
+
+def run_command(command)
+  puts(command)
+  puts(`#{command}`)
+end
+
+
+home = ENV['HOME']
+output_dir = File.join(home, 'sql-backups')
+blognames = %w(blog1 blog2)
+
+
+blognames.each do |blogname|
+
+  blog_dir = File.join(home, 'public_html', blogname)
+  parser = WCParser.new(blog_dir)
+  time_str = Time.now.strftime("%Y_%m_%d__%H%M%S")
+  outfilespec = File.join(output_dir, "#{blogname}-db-backup-#{time_str}.sql")
+
+  user     = Shellwords.escape(parser.db_user)
+  password = Shellwords.escape(parser.db_password)
+  host     = Shellwords.escape(parser.db_host)
+  name     = Shellwords.escape(parser.db_name)
+
+
+  Dir.chdir(home) do   # in case you have another .git dir where you are
+    run_command("mysqldump -u#{user} -p#{password} -h#{host} #{name} 2>&1 | tee #{outfilespec}")
+    run_command("git add #{outfilespec} 2>&1")
+    run_command("git commit -m \"Added #{outfilespec}.\"")
+  end
+end
+
+run_command("git push -u origin master")
+```
+
+CAUTION:
+
+It is assumed that the key in the config file is always, and all, upper case.
+Any key passed to the get and [] methods, or as a method name, will be
+converted to an upper case string for which to search in the config file.
+
+If you use the method name approach of reading the value for a key,
+then a NoMethodError will be raised if the key did not exist in the file.
+If you don't want that to happen, you can use the get or [] methods instead,
+as they return nil rather than raising an error.  For example:
+
+```ruby
+value = parser[:db_xyz]
+# instead of
+value = parser.db_xyz
+```
+
+You can also call has_key? (with either string or symbol) to see if it's there
+before trying to get it.  This function is very fast, and pulls the value into
+the cache if it wasn't already there, so the subsequent access to get the
+actual value is very fast.
+
+It is highly recommended to use Shellwords.escape on any values found
+in the config file before passing those values to a command line.
+You wouldn't want someone modifying a value to include "; rm -rf ~"!
+
+
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wordpress_config_parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wordpress_config_parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/wordpress_config_parser/version.rb

@@ -0,0 +1,3 @@
+module WordpressConfigParser
+  VERSION = "0.9.0"
+end

data/lib/wordpress_config_parser/wc_parser.rb

@@ -0,0 +1,95 @@
+class WCParser
+
+  attr_accessor :lines
+
+  def initialize(filespec_or_array)
+
+    error_message = "WCParser constructor must be passed an array of lines, " +
+        "a config filespec, or a directory name that contains a wp-config.php file."
+
+    case filespec_or_array
+
+      when Array
+        @lines = filespec_or_array
+
+      when String
+        filespec = filespec_or_array
+        unless File.exists?(filespec)
+          raise ArgumentError.new("File/directory '#{filespec}' does not exist. #{error_message}")
+        end
+
+        if File.directory?(filespec)
+          filespec = File.join(filespec, 'wp-config.php')
+          unless File.exists?(filespec)
+            raise ArgumentError.new("File '#{filespec}' does not exist.  #{error_message}")
+          end
+        end
+
+        @lines = File.readlines(filespec).map(&:chomp)
+
+      else
+        raise ArgumentError.new(error_message)
+    end
+
+    @cache = {}
+  end
+
+  # Ex: define('DB_NAME', 'abcdefgh_0001');
+  def find_def_line(token)
+    search_string = "define('#{token}'"
+    matches = lines.select { |line| line[0...search_string.size] == search_string }
+    matches.empty? ? nil : matches.last  # last one wins
+  end
+
+
+  def extract_value_from_line(line)
+    # Ex: define('DB_NAME', 'abcdefgh_0001');
+    # Splitting by ' will leave value as array[3]
+    line.split("'")[3]
+  end
+
+  def get(token)
+
+    hash_key = token.to_s.downcase.to_sym
+
+    if @cache.has_key?(hash_key)
+      value = @cache[hash_key]
+    else
+      config_file_key = token.to_s.upcase
+      line = find_def_line(config_file_key)
+      value = (line.nil? ? nil : extract_value_from_line(line))
+      @cache[hash_key] = value # Note: cache will contain any invalid keys requested
+    end
+    value
+  end
+
+
+  def has_key?(key)
+    !! get(key)
+  end
+
+
+  alias [] get
+
+  # For missing methods, assume the method_name is the name or symbol
+  # of a defined value's key.  If the key exists in the config file,
+  # a method is created and that value returned.  Otherwise, super's
+  # method_missing will be called.
+  def method_missing(method_name, *method_args)
+
+    value = get(method_name)
+
+    if value.nil?
+      super.method_missing(method_name, *method_args)
+    else
+      instance_eval("""
+          def #{method_name.to_s.downcase}
+            get('#{method_name.to_s.upcase}')
+          end
+      """)
+    end
+
+    value
+  end
+
+end

data/lib/wordpress_config_parser.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'wordpress_config_parser'))
+
+require "wordpress_config_parser/version"
+
+
+module WordpressConfigParser
+
+  require 'wc_parser'
+end

data/make-gem.sh

@@ -0,0 +1,7 @@
+gem uninstall wordpress_config_parser
+rm wordpress_config_parser*gem
+gem build wordpress_config_parser.gemspec
+gem install wordpress_config_parser*gem
+
+ruby -e "require 'wordpress_config_parser'; parser = WCParser.new('spec/resources'); puts parser.db_name; puts parser.db_name"
+

data/sample_scripts/backup-wordpress-db.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+#
+# backup-wordpress-db.rb
+#
+# Calls mysqldump to create a backup of a MySQL data base
+# in the form of a .sql file containing the SQL commands
+# required to reconstruct it.
+#
+# Assumptions:
+#
+# 1) The directory containing the output (backup) files is in a git repo.
+#
+# 2) Either you have .ssh keys set up, or you're willing to
+#    type in your password for the git push.
+#
+# 3) You're storing your SQL backup files in ~/sql-backups, and
+#    that directory already exists.
+#
+# 4) The blogs are all under the $HOME/public_html directory.
+#
+# 5) There are no changes git added when you run this script.
+#    Otherwise, those changes will be included in the commit,
+#    without any commit message to describe them.
+
+require 'wordpress_config_reader'
+require 'shellwords'
+
+if ARGV.empty?
+  puts "Syntax is backup-wordpress.rb blog_dir_name_1 [...blog_dir_name_n]."
+  exit -1
+end
+
+
+def run_command(command)
+  puts(command)
+  puts(`#{command}`)
+end
+
+
+home = ENV['HOME']
+output_dir = File.join(home, 'sql-backups')
+blognames = ARGV
+
+blognames.each do |blogname|
+
+  blog_dir = File.join(home, 'public_html', blogname)
+  reader = WCReader.new(blog_dir)
+  outfilespec = File.join(output_dir, "#{blogname}-db-backup.sql")
+
+  user     = Shellwords.escape(reader.db_user)
+  password = Shellwords.escape(reader.db_password)
+  host     = Shellwords.escape(reader.db_host)
+  name     = Shellwords.escape(reader.db_name)
+
+
+  Dir.chdir(output_dir) do  # make sure we're in the right repo
+    run_command("mysqldump -u#{user} -p#{password} -h#{host} #{name} 2>&1 | tee #{outfilespec}")
+    run_command("git add #{outfilespec} 2>&1")
+  end
+end
+
+
+run_command("git commit -m \"Updated SQL backups for blogs: #{blognames.join(', ')}.\"")
+run_command("git push -u origin master")

data/spec/resources/wp-config.php

@@ -0,0 +1,94 @@
+<?php
+/**
+!!! DO NOT MODIFY THIS FILE!!!!
+!!! FILE CONTENT IS ASSUMED BY UNIT TESTS !!!
+
+ * The base configurations of the WordPress.
+ *
+ * This file has the following configurations: MySQL settings, Table Prefix,
+ * Secret Keys, WordPress Language, and ABSPATH. You can find more information
+ * by visiting {@link http://codex.wordpress.org/Editing_wp-config.php Editing
+ * wp-config.php} Codex page. You can get the MySQL settings from your web host.
+ *
+ * This file is used by the wp-config.php creation script during the
+ * installation. You don't have to use the web site, you can just copy this file
+ * to "wp-config.php" and fill in the values.
+ *
+ * @package WordPress
+ */
+
+// ** MySQL settings - You can get this info from your web host ** //
+/** The name of the database for WordPress */
+define('DB_NAME', 'mysite_wrd1');
+define('DB_NAME', 'mysite_wrd2');
+
+/** MySQL database username */
+define('DB_USER', 'mysite_user');
+
+/** MySQL database password */
+define('DB_PASSWORD', 'gobbledygook');
+
+/** MySQL hostname */
+define('DB_HOST', 'localhost');
+
+/** Database Charset to use in creating database tables. */
+define('DB_CHARSET', 'utf8');
+
+/** The Database Collate type. Don't change this if in doubt. */
+define('DB_COLLATE', '');
+
+/**#@+
+ * Authentication Unique Keys and Salts.
+ *
+ * Change these to different unique phrases!
+ * You can generate these using the {@link https://api.wordpress.org/secret-key/1.1/salt/ WordPress.org secret-key service}
+ * You can change these at any point in time to invalidate all existing cookies. This will force all users to have to log in again.
+ *
+ * @since 2.6.0
+ */
+define('AUTH_KEY',         '1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+define('SECURE_AUTH_KEY',  '2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+define('LOGGED_IN_KEY',    '3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+define('NONCE_KEY',        '4xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+define('AUTH_SALT',        '5xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+define('SECURE_AUTH_SALT', '6xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+define('LOGGED_IN_SALT',   '7xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+define('NONCE_SALT',       '8xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
+
+/**#@-*/
+
+/**
+ * WordPress Database Table prefix.
+ *
+ * You can have multiple installations in one database if you give each a unique
+ * prefix. Only numbers, letters, and underscores please!
+ */
+$table_prefix  = 'wp_';
+
+/**
+ * WordPress Localized Language, defaults to English.
+ *
+ * Change this to localize WordPress. A corresponding MO file for the chosen
+ * language must be installed to wp-content/languages. For example, install
+ * de_DE.mo to wp-content/languages and set WPLANG to 'de_DE' to enable German
+ * language support.
+ */
+define('WPLANG', '');
+
+/**
+ * For developers: WordPress debugging mode.
+ *
+ * Change this to true to enable the display of notices during development.
+ * It is strongly recommended that plugin and theme developers use WP_DEBUG
+ * in their development environments.
+ */
+define('WP_DEBUG', false);
+
+/* That's all, stop editing! Happy blogging. */
+
+/** Absolute path to the WordPress directory. */
+if ( !defined('ABSPATH') )
+	define('ABSPATH', dirname(__FILE__) . '/');
+
+/** Sets up WordPress vars and included files. */
+require_once(ABSPATH . 'wp-settings.php');

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib', 'wordpress_config_parser'))
+

data/spec/wordpress_config_reader/wc_reader_spec.rb

@@ -0,0 +1,82 @@
+require_relative '../spec_helper'
+require 'wc_parser'
+require 'tempfile'
+
+describe WCParser do
+
+
+  let(:sample_lines) { %w(abc 789) }
+  let(:sample_dirspec) { File.expand_path(File.join(File.dirname(__FILE__), '..', 'resources')) }
+  let(:sample_filespec) { File.join(sample_dirspec, 'wp-config.php') }
+  let(:sample_parser) { WCParser.new(sample_filespec) }
+
+  it "should initialize correctly when calling create_with_lines" do
+    parser = WCParser.new(sample_lines)
+    parser.lines.should == sample_lines
+  end
+
+  it "parser.lines should be an array when instantiating with a filespec" do
+    sample_parser.lines.should be_a Array
+  end
+
+  it "parser.lines should equal the initial array when calling create_with_filespec" do
+    parser = WCParser.new(sample_filespec)
+    parser.lines.should == File.readlines(sample_filespec).map(&:chomp)
+  end
+
+  it "should correctly extract the value from a config line" do
+    config_line = "define('DB_NAME', 'abcdefgh_0001');"
+    sample_parser.extract_value_from_line(config_line).should == 'abcdefgh_0001'
+  end
+
+  it "should extract the correct line when > 1 matches are present" do
+    line = sample_parser.find_def_line('DB_NAME')
+    value = sample_parser.extract_value_from_line(line)
+    value.should == 'mysite_wrd2'
+  end
+
+  it "(get) should get the correct value" do
+    sample_parser.get('DB_NAME').should == 'mysite_wrd2'
+  end
+
+  it "[] operator should get the correct value" do
+    sample_parser['DB_NAME'].should == 'mysite_wrd2'
+  end
+
+  it "should correctly generate a new method when receiving a property in lower case" do
+    sample_parser.db_name.should == 'mysite_wrd2'
+  end
+
+  it "should correctly create a mysqladmin dump command with parameters from the file" do
+    db_name = sample_parser.db_name
+    db_password = sample_parser.db_password
+    db_hostname = sample_parser.db_host
+    db_user = sample_parser.db_user
+
+    # mysqldump -u#{userid} -p#{password} -h#{hostname} #{database_name} 2>&1 > #{outfilespec}`
+    command = "mysqldump -u#{db_user} -p#{db_password} -h#{db_hostname} #{db_name}"
+    expected = "mysqldump -umysite_user -pgobbledygook -hlocalhost mysite_wrd2"
+    command.should == expected
+  end
+
+  it "should correctly return true for has_key?(:db_name) and has_key?('DB_NAME')" do
+    (sample_parser.has_key?(:db_name) && sample_parser.has_key?('DB_NAME')).should be_true
+  end
+
+  it "should correctly return false for has_key?(:zyx) and has_key?('ZYX')" do
+    (sample_parser.has_key?(:zyx) || sample_parser.has_key?('ZYX')).should be_false
+  end
+
+  it "should throw an ArgumentError if a bad file is provided" do
+    lambda { WCParser.new('/:!@#$%^&') }.should raise_error(ArgumentError)
+  end
+
+  it "should throw an ArgumentError if a something other than a string or array is provided" do
+    lambda { WCParser.new(123) }.should raise_error(ArgumentError)
+  end
+
+  it "should throw a NoMethodError if a method is called for which there is no key" do
+    lambda { sample_parser.foo }.should raise_error(NoMethodError)
+  end
+
+end

data/wordpress_config_parser.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/wordpress_config_parser/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Keith Bennett"]
+  gem.email         = ["keithrbennett@gmail.com"]
+  gem.description   = %q{Gets values defined in Wordpress wp-config.php file.}
+  gem.summary       = %q{Gets values defined in Wordpress wp-config.php file.}
+  gem.homepage      = "https://github.com/keithrbennett/wordpress_config_parser"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "wordpress_config_parser"
+  gem.require_paths = ["lib"]
+  gem.version       = WordpressConfigParser::VERSION
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: wordpress_config_parser
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Keith Bennett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-21 00:00:00.000000000 Z
+dependencies: []
+description: Gets values defined in Wordpress wp-config.php file.
+email:
+- keithrbennett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/wordpress_config_parser.rb
+- lib/wordpress_config_parser/version.rb
+- lib/wordpress_config_parser/wc_parser.rb
+- make-gem.sh
+- sample_scripts/backup-wordpress-db.rb
+- spec/resources/wp-config.php
+- spec/spec_helper.rb
+- spec/wordpress_config_reader/wc_reader_spec.rb
+- wordpress_config_parser.gemspec
+homepage: https://github.com/keithrbennett/wordpress_config_parser
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Gets values defined in Wordpress wp-config.php file.
+test_files:
+- spec/resources/wp-config.php
+- spec/spec_helper.rb
+- spec/wordpress_config_reader/wc_reader_spec.rb