obvious_data 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a5efa45b6275255bb8f84d1dfc88f96099d71a5
+  data.tar.gz: d9a58e97f51dc582568b72133f7377fd5639642a
+SHA512:
+  metadata.gz: d3e223098cc9bac39cb11046cdf220e21df9b7a10879fd0435dfb383ca780ae8a4d40b3373b282d9799638e792639a0fe0041c82e48e70c69e72b27fe538d3c4
+  data.tar.gz: 03f9e4c607b4cade7779af28149dc069c8ec3965133d1e814472bb13b3ddc0c6b05dda9fdcb9415406747e90ae89d146d2a2269146f674f43c0af43fdafcbca0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,116 @@
+Obvious Data
+============
+Rails gem to treat DB functions, triggers, etc more like code, and make them more discoverable
+
+Premise
+=======
+Database functions, triggers, and views can be very powerful when used in the right circumstances, but they lack the discoverability and versioning of source code. Short of logging into your databases, it is difficult to tell what versions of functions and triggers are active, nevermind getting a good picture of what are all the custom functions and triggers in place in your application.
+
+Obvious Data improves this by creating directories for you to place these constructs, treating them more like code and instantly making them greppable, and adding helper methods where you can easily use these files from your migrations.
+
+Usage
+=====
+
+### Creating directories
+```
+$ bin/rails generate obvious_data_directories
+```
+
+This will generate empty `db/functions`, `db/views`, and `db/triggers` directories for you to use.
+
+### Adding functions
+Say you want to add a function called `one()`. You should create a file called `one.sql` in `db/functions/` with the SQL that's needed to add that function. Thus:
+
+_db/functions/one.sql_:
+
+```
+CREATE OR REPLACE FUNCTION one() RETURNS integer AS $$
+  SELECT 1 AS result;
+$$ LANGUAGE SQL;
+```
+
+Then, from a migration you can add this function like:
+
+*db/migrate/20140724185749_create_one_function.rb*
+
+```ruby
+class CreateDummyTable < ActiveRecord::Migration
+  def up
+    execute_function_file 'one'
+  end
+
+  def down
+    drop_function 'one()'
+  end
+end
+```
+
+Run your migration and your function should be operational!
+
+### Changing functions
+Say it is suddenly decreed that the numeric representation of "one" is now 99. To keep the active version of your function discoverable, you are expected to change the same function file you created in the above section in place, and updating it through a new migration. So:
+
+*db/functions/one.sql*:
+
+```
+CREATE OR REPLACE FUNCTION one() RETURNS integer AS $$
+  SELECT 99 AS result;
+$$ LANGUAGE SQL;
+```
+
+*db/migrate/20140724185750_one_function_to_99.rb*
+
+```ruby
+class CreateDummyTable < ActiveRecord::Migration
+  def up
+    execute_function_file 'one'
+  end
+
+  def down
+    # Unfortunately there's currently no easy way to revert this situation
+  end
+end
+```
+
+### Dropping functions
+What do you do when you no longer want to use a class from your source code? You delete it! Which is the same thing we'll do here. In the migration, make sure to use the full function signature instead of just the function name.
+
+*db/functions/one.sql: *deleted**
+
+*db/migrate/20140724185751_drop_one_function.rb:*
+
+```ruby
+class CreateDummyTable < ActiveRecord::Migration
+  def up
+    drop_function 'one()'
+  end
+
+  def down
+    # Unfortunately there's currently no easy way to revert this situation
+  end
+end
+```
+
+### Adding/changing/dropping views and triggers
+Practically the same as adding and changing functions. The available migration helpers are:
+
+- `execute_view_file(view_name)`
+- `drop_view(view_name)`
+- `execute_trigger_file(trigger_name)`
+- `drop_trigger(trigger_name, table_trigger_is_on)`
+
+Supported Databases etc
+=======================
+
+- Currently the only database supported is PostgreSQL, but no reason that other DBs can't also be supported
+- This has been tested with Rails 3.2.x and Ruby 2.1.x and 1.9.3
+
+Contributing
+============
+Make sure you run the tests before and after making changes. Here's how:
+
+- Ensure PostgreSQL is installed
+- Run `bundle install`
+- Run `bundle exec rake app:db:create`
+- Run `bundle exec rake app:db:setup app:db:migrate app:db:test:prepare`
+- Run `bundle exec rspec`

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/generators/obvious_data_directories_generator.rb

@@ -0,0 +1,7 @@
+class ObviousDataDirectoriesGenerator < Rails::Generators::Base
+  def create_obvious_data_directories
+    empty_directory "db/functions"
+    empty_directory "db/triggers"
+    empty_directory "db/views"
+  end
+end

data/lib/obvious_data.rb

@@ -0,0 +1,7 @@
+require 'obvious_data/version'
+require 'obvious_data/schema_methods'
+require 'obvious_data/command_recorder_methods'
+require 'obvious_data/railtie' if defined?(Rails)
+
+module ObviousData
+end

data/lib/obvious_data/command_recorder_methods.rb

@@ -0,0 +1,28 @@
+# At present no obvious_data helpers are auto-invertible. We can't just drop a function
+# executed via #execute_function_file cause that helper is _also_ used to update existing
+# functions. Might address that later.
+module ObviousData::CommandRecorderMethods
+  def execute_function_file(*args)
+    record(:execute_function_files, args)
+  end
+
+  def drop_function(*args)
+    record(:drop_function, args)
+  end
+
+  def execute_view_file(*args)
+    record(:execute_view_file, args)
+  end
+
+  def drop_view(*args)
+    record(:drop_view, args)
+  end
+
+  def execute_trigger_file(*args)
+    record(:execute_trigger_file, args)
+  end
+
+  def drop_trigger(*args)
+    record(:drop_trigger, args)
+  end
+end

data/lib/obvious_data/railtie.rb

@@ -0,0 +1,17 @@
+require 'active_record/railtie'
+
+module ObviousData
+  class Railtie < ::Rails::Railtie
+    initializer 'obvious_data' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+          include ObviousData::SchemaMethods
+        end
+
+        ActiveRecord::Migration::CommandRecorder.class_eval do
+          include ObviousData::CommandRecorderMethods
+        end
+      end
+    end
+  end
+end

data/lib/obvious_data/schema_methods.rb

@@ -0,0 +1,28 @@
+module ObviousData::SchemaMethods
+  def execute_function_file(function)
+    path = Rails.root.join('db', 'functions', "#{function}.sql")
+    execute(File.read(path))
+  end
+
+  def drop_function(signature)
+    execute "DROP FUNCTION IF EXISTS #{signature};"
+  end
+
+  def execute_view_file(view)
+    path = Rails.root.join('db', 'views', "#{view}.sql")
+    execute(File.read(path))
+  end
+
+  def drop_view(signature)
+    execute "DROP VIEW IF EXISTS #{signature};"
+  end
+
+  def execute_trigger_file(trigger)
+    path = Rails.root.join('db', 'triggers', "#{trigger}.sql")
+    execute(File.read(path))
+  end
+
+  def drop_trigger(trigger, table)
+    execute "DROP TRIGGER IF EXISTS #{trigger} ON #{table};"
+  end
+end

data/lib/obvious_data/version.rb

@@ -0,0 +1,3 @@
+module ObviousData
+  VERSION = "0.0.1"
+end

data/lib/tasks/obvious_data_tasks.rake

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

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.