wpdb_activerecord 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7182772d3f84493da9908b61ae1207395500d40d
+  data.tar.gz: 9d74d9f27b6b6aa5dbe0202ea3565b5aa1ad5ca7
+SHA512:
+  metadata.gz: 5332e9327c586fb74c762950edd60fb0daaf2a1530c667e7e0dd9c04164effa76d81e789b4492913d3bf4d657bdaee5932db9e4af8d5adf16d0282bdd4555260
+  data.tar.gz: 209eb7039bc90da1bc2535f8dcc1b7e4ffdae1337b299fc4bd47cc06deddfa470ab7e6d2e7548b429fbdf1a13178d92858e91e8f384c17e99a1147e783ed27fd

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in wpdb_activerecord.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+gem 'php-serialize', '~> 1.1', require: 'php_serialize'
+gem 'phpass-ruby', '~> 0.1', require: 'phpass'
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 ronald.hsu
+
+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.rdoc

@@ -0,0 +1,59 @@
+# wpdb_activerecord
+
+If you'd like to do it in Ruby instead, then this library might help
+with some of the boilerplate.
+
+It's a wrapper for the WordPress database, using
+[ActiveRecord](http://apidock.com/rails/ActiveRecord), that gives you access to the
+WordPress database and all its content via a nice ORM.
+
+## Installation
+
+```
+gem "wpdb_activerecord", git: "https://github.com/hothero/wpdb_activerecord"
+```
+
+## Usage
+
+####Post###
+```
+WPDB::Post.all # Get all posts
+@post = WPDB::Post.find(75)
+@post.tags
+@post.categories
+@post.attachments # No matter what type
+@post.revisions # versions
+@post.postmetas # post meta values
+@post.author # get user (WPDB::User)
+```
+
+####Term####
+```
+WPDB::Term.tag # get all tags
+WPDB::Term.category # get all categories
+```
+
+####User####
+```
+@user = WPDB::User.find(25)
+@user.posts
+```
+
+## Advanced ##
+Sometime we will custom the table name prefix (default is wp_) or inherit to use and redefine something.
+
+You can define your yaml file to setup prefix and association class_name.
+
+Put the config file named "wpdb_activerecord.yml" in config
+
+Example:
+
+```
+# config/wpdb_activerecord.yml
+WPDB_PREFIX: "cgjbugpbs_" # the table of WPDB::Post is cgjbugpbs_posts, not wp_posts
+WPDB_USER_CLASS: "WUser"
+
+# usage
+@author = WPDB::Post.find(25).author
+@author.class_name # will get WUser, not WPDB::User
+```

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WpdbActiverecord'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/tasks/wpdb_activerecord_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :wpdb_activerecord do
+#   # Task goes here
+# end

data/lib/wpdb_activerecord/configuration.rb

@@ -0,0 +1,35 @@
+module WPDB
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+  end
+
+  class Configuration
+    attr_accessor :prefix, :post_class, :postmeta_class, :term_class,
+                  :term_relationship_class, :term_taxonomy_class,
+                  :user_class, :usermeta_class
+
+    def initialize
+      path = File.join(root, "config", "wpdb_config.yml")
+      config = File.exists?(path) ? YAML.load_file(path) : Hash.new
+      @prefix = config["WPDB_PREFIX"] || "wp_"
+      @post_class = config["WPDB_POST_CLASS"] || "WPDB::Post"
+      @postmeta_class = config["WPDB_POSTMETA_CLASS"] || "WPDB::Postmeta"
+      @term_class = config["WPDB_TERM_CLASS"] || "WPDB::Term"
+      @term_relationship_class = config["WPDB_TERM_RELATIONSHIP_CLASS"] || "WPDB::TermRelationship"
+      @term_taxonomy_class = config["WPDB_TERM_TAXONOMY_CLASS"] || "WPDB::TermTaxonomy"
+      @user_class = config["WPDB_USER_CLASS"] || "WPDB::User"
+      @usermeta_class = config["WPDB_USERMETA_CLASS"] || "WPDB::Usermeta"
+    end
+
+    def root
+      Rails.root || Pathname.new(ENV["RAILS_ROOT"] || Dir.pwd)
+    end
+  end
+end
+
+WPDB.configure

data/lib/wpdb_activerecord/option.rb

@@ -0,0 +1,6 @@
+module WPDB
+  class Option < ActiveRecord::Base
+    self.table_name = "#{WPDB.configuration.prefix}options"
+    self.primary_key = :option_id
+  end
+end

data/lib/wpdb_activerecord/post.rb

@@ -0,0 +1,19 @@
+module WPDB
+  class Post < ActiveRecord::Base
+    self.table_name = "#{WPDB.configuration.prefix}posts"
+    self.primary_key = :ID
+
+    belongs_to :author, class_name: WPDB.configuration.user_class, foreign_key: "post_author"
+    belongs_to :parent, class: self
+
+    # tag / category
+    has_many :term_relationships, foreign_key: "object_id", class_name: WPDB.configuration.term_relationship_class
+    has_many :terms, through: :term_relationships, foreign_key: "term_id", class_name: WPDB.configuration.term_class
+    has_many :tags, -> { where("#{WPDB.configuration.term_taxonomy_class.constantize.table_name}.taxonomy = 'post_tag'") }, through: :terms, source: :term_taxonomy, class_name: WPDB.configuration.term_class
+    has_many :categories, -> { where("#{WPDB.configuration.term_taxonomy_class.constantize.table_name}.taxonomy = 'category'") }, through: :terms, source: :term_taxonomy, class_name: WPDB.configuration.term_class
+
+    has_many :attachments, -> { where(post_type: "attachment") }, foreign_key: "post_parent", class: self
+    has_many :revisions, -> { where(post_type: "revision") }, foreign_key: "post_parent", class: self
+    has_many :postmetas, foreign_key: "post_id", class_name: WPDB.configuration.postmeta_class
+  end
+end

data/lib/wpdb_activerecord/postmeta.rb

@@ -0,0 +1,8 @@
+module WPDB
+  class Postmeta < ActiveRecord::Base
+    self.table_name = "#{WPDB.configuration.prefix}postmeta"
+    self.primary_key = :meta_id
+
+    belongs_to :post, foreign_key: "post_id", class_name: WPDB.configuration.post_class
+  end
+end

data/lib/wpdb_activerecord/term.rb

@@ -0,0 +1,12 @@
+module WPDB
+  class Term < ActiveRecord::Base
+    self.table_name = "#{WPDB.configuration.prefix}terms"
+    self.primary_key = :term_id
+
+    has_one :term_taxonomy, foreign_key: "term_id", class_name: WPDB.configuration.term_taxonomy_class
+    has_many :term_taxonomies, foreign_key: "term_id", class_name: WPDB.configuration.term_taxonomy_class
+
+    scope :tag, -> { joins(:term_taxonomy).where("#{WPDB.configuration.term_taxonomy_class.constantize.table_name}.taxonomy = 'post_tag'") }
+    scope :category, -> { joins(:term_taxonomy).where("#{WPDB.configuration.term_taxonomy_class.constantize.table_name}.taxonomy = 'category'") }
+  end
+end

data/lib/wpdb_activerecord/term_relationship.rb

@@ -0,0 +1,10 @@
+module WPDB
+  class TermRelationship < ActiveRecord::Base
+    self.table_name = "#{WPDB.configuration.prefix}term_relationships"
+    self.primary_key =  :object_id
+
+    belongs_to :term_taxonomy, foreign_key: "term_taxonomy_id", class_name: WPDB.configuration.term_taxonomy_class
+
+    belongs_to :post, foreign_key: "object_id", class_name: WPDB.configuration.post_class
+  end
+end

data/lib/wpdb_activerecord/term_taxonomy.rb

@@ -0,0 +1,11 @@
+module WPDB
+  class TermTaxonomy < ActiveRecord::Base
+    self.table_name = "#{WPDB.configuration.prefix}term_taxonomy"
+    self.primary_key = :term_taxonomy_id
+
+    belongs_to :term, foreign_key: "term_id", class_name: WPDB.configuration.term_class
+    has_many :term_relationships, foreign_key: "term_taxonomy_id", class_name: WPDB.configuration.term_relationship_class
+
+    has_many :posts, through: :term_relationships, class_name: WPDB.configuration.post_class
+  end
+end

data/lib/wpdb_activerecord/user.rb

@@ -0,0 +1,13 @@
+module WPDB
+  class User < ActiveRecord::Base
+    self.table_name = "#{WPDB.configuration.prefix}users"
+    self.primary_key = :ID
+
+    has_many :posts, foreign_key: "post_author", class_name: WPDB.configuration.post_class
+    has_many :usermetas, foreign_key: "user_id", class_name: WPDB.configuration.usermeta_class
+
+    def check_password?(password)
+      phpass.check(password, self.user_pass)
+    end
+  end
+end

data/lib/wpdb_activerecord/usermeta.rb

@@ -0,0 +1,8 @@
+module WPDB
+  class Usermeta < ActiveRecord::Base
+    self.table_name = "#{WPDB.configuration.prefix}usermeta"
+    self.primary_key = :umeta_id
+
+    belongs_to :user, foreign_key: "user_id", class_name: WPDB.configuration.user_class
+  end
+end

data/lib/wpdb_activerecord/version.rb

@@ -0,0 +1,3 @@
+module WpdbActiverecord
+  VERSION = "1.0"
+end

data/lib/wpdb_activerecord.rb

@@ -0,0 +1,14 @@
+require "wpdb_activerecord/configuration"
+
+require_relative "wpdb_activerecord/option"
+require_relative "wpdb_activerecord/post"
+require_relative "wpdb_activerecord/postmeta"
+require_relative "wpdb_activerecord/term"
+require_relative "wpdb_activerecord/term_relationship"
+require_relative "wpdb_activerecord/term_taxonomy"
+require_relative "wpdb_activerecord/user"
+require_relative "wpdb_activerecord/usermeta"
+
+module WPDB
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "wpdb_activerecord"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end