RubyGems - transcribable - Versions diffs - 0.0.1 - Mend

transcribable 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

data/MIT-LICENSE +20 -0
data/Rakefile +32 -0
data/lib/generators/templates/assets/stylesheets/simple_frame.css +284 -0
data/lib/generators/templates/config/documentcloud.yml +3 -0
data/lib/generators/templates/controller.rb +48 -0
data/lib/generators/templates/migration.rb +15 -0
data/lib/generators/templates/migration_add_columns.rb +13 -0
data/lib/generators/templates/model.rb +10 -0
data/lib/generators/templates/views/_form.html.erb +32 -0
data/lib/generators/templates/views/layouts/simple_frame.html.erb +50 -0
data/lib/generators/templates/views/new.html.erb +28 -0
data/lib/generators/transcribable_generator.rb +59 -0
data/lib/tasks/harvester.rake +23 -0
data/lib/transcribable.rb +156 -0
data/lib/transcribable/railtie.rb +11 -0
data/lib/transcribable/version.rb +3 -0
data/test/dummy/README.rdoc +28 -0
data/test/dummy/Rakefile +6 -0
data/test/dummy/app/assets/javascripts/application.js +13 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +5 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/models/filing.rb +6 -0
data/test/dummy/app/models/transcription.rb +10 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/bin/bundle +3 -0
data/test/dummy/bin/rails +4 -0
data/test/dummy/bin/rake +4 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +23 -0
data/test/dummy/config/boot.rb +5 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +29 -0
data/test/dummy/config/environments/production.rb +80 -0
data/test/dummy/config/environments/test.rb +36 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/test/dummy/config/initializers/inflections.rb +16 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +12 -0
data/test/dummy/config/initializers/session_store.rb +3 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +23 -0
data/test/dummy/config/routes.rb +56 -0
data/test/dummy/db/schema.rb +19 -0
data/test/dummy/db/test.sqlite3 +0 -0
data/test/dummy/log/test.log +979 -0
data/test/dummy/public/404.html +58 -0
data/test/dummy/public/422.html +58 -0
data/test/dummy/public/500.html +57 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/test_helper.rb +15 -0
data/test/transcribable_test.rb +72 -0
metadata +202 -0

data/lib/generators/templates/views/layouts/simple_frame.html.erb ADDED

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <meta name="viewport" content="width=device-width">
+    <%%= stylesheet_link_tag :simple_frame %>
+    <%%= yield :css %>
+    <!-- switchy -->
+    <meta name="viewport" content="width=device-width, maximum-scale=1.6">
+    <!-- /switchy -->
+    <script src="//s3.amazonaws.com/s3.documentcloud.org/viewer/loader.js"></script>
+    <%%= yield :javascripts %>
+    <%%= yield :header %>
+    <title><%%= yield :title %></title>
+  </head>
+  <body class="app" id="simple_wrapper">
+    <div id="banner">
+      <div class="wrapper">
+        <div id="banner-identity">
+          <p id="app-tagline">My Transcribable App</p>
+        </div>
+      </div>
+    </div>
+    <div id="banner-nav">
+      <div class="wrapper">
+        <div style="clear:both"></div>
+      </div>
+    </div>
+    <div id="content">
+      <div class="wrapper">
+        <div id="modal-screen-coverer"></div>
+        <div id="simple_frame">
+          <%%= yield %>
+        </div>
+      </div>
+    </div>
+    <div id="fb-root"></div>
+    <div id="footer">
+      <div class="wrapper">
+        <div id="footer-logo">
+          <p id="footer-logo-image">My Transcribable App</p>
+        </div>
+        <div style="clear:both;"></div>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/generators/templates/views/new.html.erb ADDED

@@ -0,0 +1,28 @@
+<%% if flash[:alert] %>
+  <div class="warn"><%%= flash[:alert] %></div>
+<%% end %>
+<%% if flash[:notice] %>
+  <div class="notice"><%%= flash[:notice] %></div>
+<%% end %>
+<h1><%%= "Tell Us About This Document" %></h1>
+<div id="left-dc-embed">
+  <div id="doc">
+  </div>
+</div>
+  <div id="right-column">
+    <%%= render 'form' %>
+  </div>
+<script>
+  var CURRENT_DOCUMENT = DV.load("https://documentcloud.org/documents/<%%= @<%= @table.singularize %>.dc_slug %>.js", {
+    container : '#doc',
+    width     : 660,
+    height    : 900,
+    zoom      : 'auto',
+    showSidebar : false,
+    embedded  : true,
+    showAnnotations : false
+     //afterLoad : setupViewer
+  });
+</script>

data/lib/generators/transcribable_generator.rb ADDED

@@ -0,0 +1,59 @@
+require "rails/generators"
+require "rails/generators/active_record"
+require "transcribable"
+class TranscribableGenerator < ActiveRecord::Generators::Base
+  include Transcribable
+  desc "Generates transcriptions table"
+  # to get around AR Generators requiring a NAME param
+  argument :name, type: :string, default: 'random_name'
+  source_root File.expand_path('../templates', __FILE__)
+  def table
+    @table = Transcribable.table
+  end
+  def transcribable_attrs
+    Transcribable.transcribable_attrs
+  end
+  def new_columns
+    Transcribable.new_columns
+  end
+  def copy_files
+    # Copies the migration template to db/migrate.
+    if Transcribable.new_columns.length > 0
+      @migration_name = "add_#{Transcribable.new_columns.keys.join("_and_")}_to_transcriptions"
+      migration_template 'migration_add_columns.rb', "db/migrate/#{@migration_name}.rb"
+    elsif !ActiveRecord::Base.connection.tables.include?("transcriptions")
+      migration_template 'migration.rb', 'db/migrate/create_transcriptions_table.rb'
+    end
+    # controller
+    template 'controller.rb', 'app/controllers/transcriptions_controller.rb'
+    # model
+    template 'model.rb', 'app/models/transcription.rb'
+    # views
+    template 'views/layouts/simple_frame.html.erb', 'app/views/layouts/simple_frame.html.erb'
+    template 'views/_form.html.erb', 'app/views/transcriptions/_form.html.erb'
+    template 'views/edit.html.erb', 'app/views/transcriptions/edit.html.erb'
+    template 'views/new.html.erb', 'app/views/transcriptions/new.html.erb'
+    # assets
+    template 'assets/stylesheets/simple_frame.css', 'app/assets/stylesheets/simple_frame.css'
+    # config
+    template 'config/documentcloud.yml', 'config/documentcloud.yml'
+    # routes
+    route "resources :transcriptions, :only => [:new, :create]"
+    route "resources :#{@table.to_sym}, :only => [:index, :show]"
+    route "root :to => \"#{@table}#index\""
+  end
+end

data/lib/tasks/harvester.rake ADDED

@@ -0,0 +1,23 @@
+namespace :transcribable do
+  desc "Harvest documents to transcribe from DocumentCloud"
+  task :harvest => :environment do
+    require 'rest-client'
+    klass = Kernel.const_get(Transcribable.table.classify)
+    dc = YAML.load(File.read("#{Rails.root.to_s}/config/documentcloud.yml"))
+    dc_project = JSON.parse(RestClient.get("https://#{CGI::escape(dc['email'])}:#{CGI::escape(dc['password'])}@www.documentcloud.org/api/projects.json"))
+    dc_project = dc_project['projects'].select {|q| q['id'] == dc['project'].scan(/^\d+/)[0].to_i }[0]
+    dc_project['document_ids'].each do |doc_id|
+      begin
+        dc_doc = JSON.parse(RestClient.get("https://www.documentcloud.org/api/documents/#{doc_id}.json"))['document']
+      # this will skip non-public documents
+      rescue RestClient::ResourceNotFound
+        next
+      end
+      obj = klass.find_or_initialize_by_url("https://www.documentcloud.org/documents/#{dc_doc['id']}")
+      # don't plow over verified docs if rerunning the script
+      obj.verified = false if obj.new_record?
+      obj.save
+      puts "== added #{obj.url}"
+    end
+  end
+end

data/lib/transcribable.rb ADDED

@@ -0,0 +1,156 @@
+# adds to Filing
+require 'uuid'
+module Transcribable
+  require 'transcribable/railtie'
+  extend ActiveSupport::Concern
+  mattr_accessor :table
+  mattr_accessor :transcribable_attrs
+  included do
+    set_verification_threshhold
+  end
+  def self.table
+    # transcribable_attrs() "discovers" the columns
+    # and table. run it if we don't have a table yet.
+    transcribable_attrs if @@table.nil?
+    @@table
+  end
+  # creates a hash like...
+  # {'buyer' => :string, 'amount' => :integer}
+  def self.transcribable_attrs
+    return @@transcribable_attrs if @@transcribable_attrs
+    @@transcribable_attrs = {}
+    ActiveRecord::Base.connection.tables.reject {|t| t == "schema_migrations" }.each do |table|
+      klass = Kernel.const_get(table.classify)
+      klass.column_names.each do |col|
+        if klass.transcribable?(col)
+          @@table = table
+          @@transcribable_attrs[col] = Filing.columns_hash[col].type
+        end
+      end
+    end
+    @@transcribable_attrs
+  end
+  # If we've migrated our master table,
+  # and need transcriptions to catch up.
+  # Returns a hash like transcribable_attrs
+  def self.new_columns
+    cols = Transcribable.transcribable_attrs.keys - Transcription.columns_hash.keys
+    cols.reduce(Hash.new(0)) do |memo, it|
+      memo[it] = Kernel.const_get(@@table.classify).columns_hash[it].type
+      memo
+    end
+  end
+  module ClassMethods
+    def transcribable(*args)
+      args.each do |k|
+        self.columns_hash[k.to_s].instance_variable_set("@transcribable", true)
+      end
+      include Transcribable::LocalInstanceMethods
+    end
+    def transcribable?(_attr)
+      self.columns_hash[_attr].instance_variable_get("@transcribable")
+    end
+    def skip_verification(*args)
+      @@skip_verification = args
+    end
+    def skipped_attrs
+      @@skip_verification
+    end
+    # The number over which people must agree
+    # on every attribute to verify a transcription
+    def set_verification_threshhold(lvl = 1)
+      @@verification_threshhold = lvl
+    end
+    def verification_threshhold
+      @@verification_threshhold
+    end
+    # Attributes that are potential reasons
+    # to skip a transcription. If enough people
+    # agree to skip, the filing will be marked transcribed.
+    def skip_transcription(*args)
+      @@skippable = args
+    end
+    # Override this to write your own assigner
+    # By default, it picks a random filing that
+    # a user has not transcribed. If there's nothing left
+    # for that user to do, it returns nil. This will get slower
+    # the more transcriptions you have, so it'll be a good idea
+    # to index the filing_id (or whatever master table foreign key)
+    # column in your transcriptions table.
+    def assign!(user_id)
+      user_transcribed_filings = Transcription.where(:user_id => user_id).map {|q| q["#{self.table_name.downcase.singularize}_id".to_sym] }.uniq
+      filings = self.where(:verified => [nil, false])
+      if user_transcribed_filings.length > 0
+        filings = filings.where("id NOT IN (?)", user_transcribed_filings)
+      end
+      pick    = rand(filings.length - 1)
+      filings.length > 0 ? filings[pick] : nil
+    end
+  end
+  module LocalInstanceMethods
+    # Override this to create your own verifier.
+    # By default, all "transcribable" attributes
+    # need to be agreed on by @@verification_threshhold people.
+    def verify!
+      chosen = {}
+      attributes  = Transcribable.transcribable_attrs.keys.reject do |k|
+        self.class.skipped_attrs.include?(k.to_sym)
+      end
+      Rails.logger.info("== Verifying #{attributes.join(", ")}")
+      aggregate = transcriptions.reduce({}) do |memo, it|
+        attributes.each do |attribute|
+          memo[attribute] = memo[attribute] ? memo[attribute] : {}
+          memo[attribute][it.instance_values['attributes'][attribute].to_s.upcase] = memo[attribute][it.instance_values['attributes'][attribute].to_s.upcase] ?
+          memo[attribute][it.instance_values['attributes'][attribute].to_s.upcase] + 1 : 1
+        end
+        memo
+      end
+      aggregate.each do |attribute, answers|
+        answers.each do |answer, answer_ct|
+          if answer_ct > self.class.verification_threshhold
+            chosen[attribute] = answers.each.max_by {|k,v| v}.first
+          end
+        end
+      end
+      if chosen.keys.length == attributes.length
+        attributes.each do |a|
+          self[a] = chosen[a]
+        end
+        self.verified = true
+        self.save
+        Rails.logger.info("== Verified #{self.url}")
+      else
+        Rails.logger.info("== Not verified: #{self.url}")
+      end
+    end
+    def dc_slug
+      url.split(/\//)[-1]
+    end
+  end
+end
+ActiveRecord::Base.send :include, Transcribable

data/lib/transcribable/railtie.rb ADDED

@@ -0,0 +1,11 @@
+require 'transcribable'
+require 'rails'
+module Transcribable
+  class Railtie < Rails::Railtie
+    railtie_name :transcribable
+    rake_tasks do
+      load "tasks/harvester.rake"
+    end
+  end
+end

data/lib/transcribable/version.rb ADDED

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

data/test/dummy/README.rdoc ADDED

@@ -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 ADDED

@@ -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__)
+Dummy::Application.load_tasks

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

@@ -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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

@@ -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 ADDED

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

data/test/dummy/app/models/filing.rb ADDED

@@ -0,0 +1,6 @@
+class Filing < ActiveRecord::Base
+  transcribable :buyer, :amount, :notes
+  skip_verification :notes
+  has_many :transcriptions
+  set_verification_threshhold 4
+end

data/test/dummy/app/models/transcription.rb ADDED

@@ -0,0 +1,10 @@
+class Transcription < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :filing
+  Transcribable.transcribable_attrs.select {|k,v| [:integer, :float, :decimal].include?(v) }.keys.each do |k|
+    define_method("#{k}=") do |val|
+      write_attribute k.to_sym, val.to_s.gsub(/[^0-9\.]/,"").to_f
+    end
+  end
+end

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

@@ -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>