active_metadata 0.0.2 → 0.1.9

data/lib/active_metadata/version.rb

@@ -1,3 +1,3 @@
 module ActiveMetadata
-  VERSION = "0.0.2"
+  VERSION = "0.1.9"
 end

data/lib/active_metadata.rb

@@ -1,13 +1,7 @@
-require "active_metadata/version"
-require "mongo"
-
 module ActiveMetadata
-
-  #TODO add a configure routine
-  MONGO = Mongo::Connection.new.db "metadata"
-
-  def act_as_metadata
-
-  end
-
-end
+  require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'active_metadata/base'
+  require "active_metadata/railtie" if defined?(Rails)
+  require 'application_controller'
+  require "active_metadata/version"
+end

data/lib/application_controller.rb

@@ -0,0 +1,28 @@
+# module ActiveMetadata
+#   ## Define ControllerMethods
+#   module Controller
+#     ## this one manages the usual self.included, klass_eval stuff
+#     extend ActiveSupport::Concern
+# 
+#     included do
+#       before_filter :test_controller_instance_method
+#     end
+# 
+#     module InstanceMethods
+#       def test_controller_instance_method
+#         puts "###### This text is coming from an application_controller before_filter that is being declared and triggered from inside the engine. This before_filter is automatically integrated in when the engine is installed into an app. Look inside lib/application_controller.rb to find it. ######"
+#       end
+# 
+#       # This method is available inside application_controller but it is not being
+#       # automatically executed. Notice the before_filter line above that is automatically
+#       # executing the first method.
+#       def second_controller_instance_method
+#         puts "###### This method is not automatically run inside application_controller, but it is available inside application_controller. To see this example add 'before_filter :second_controller_instance_method' at the top of your app's application_controller.rb ######"
+#       end
+#     end
+#   end
+# end
+# 
+# ::ActionController::Base.send :include, ActiveMetadata::Controller
+# 
+# 

data/lib/application_helper.rb

@@ -0,0 +1,7 @@
+module ApplicationHelper
+  
+  def app_wide_helper_method
+    "this output is from an app-wide helper method that is declared within the gem"
+  end
+  
+end

data/lib/engine.rb

@@ -0,0 +1,29 @@
+require 'active_metadata'
+require 'rails'
+require 'action_controller'
+require 'application_helper' 
+
+module ActiveMetadata
+  class Engine < Rails::Engine
+
+    # Config defaults
+    config.mount_at = '/'
+
+    # Load rake tasks
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), 'rails/railties/tasks.rake')
+    end
+    
+    # Check the gem config
+    initializer "check config" do |app|
+
+      # make sure mount_at ends with trailing slash
+      config.mount_at += '/'  unless config.mount_at.last == '/'
+    end
+    
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+      config.generators.orm = :active_record      
+    end    
+  end  
+end

data/lib/model/active_record/attachment.rb

@@ -0,0 +1,18 @@
+class Attachment < ActiveRecord::Base
+  
+  include ::Paperclip
+  include ::Paperclip::Glue
+
+  has_attached_file :attach,
+      :path  => "#{ActiveMetadata::CONFIG['attachment_base_path']}/:document_id/:label/:id/:basename.:extension",
+      :url  => "#{ActiveMetadata::CONFIG['attachment_base_url']}/:document_id/:label/:id/:basename.:extension"
+
+  Paperclip.interpolates :document_id do |attachment,style|
+   attachment.instance.document_id
+  end
+
+  Paperclip.interpolates :label do |attachment,style|
+    attachment.instance.label
+  end
+
+end

data/lib/model/active_record/history.rb

@@ -0,0 +1,2 @@
+class History < ActiveRecord::Base
+end

data/lib/model/active_record/note.rb

@@ -0,0 +1,2 @@
+class Note < ActiveRecord::Base
+end

data/lib/model/active_record/watcher.rb

@@ -0,0 +1,4 @@
+class Watcher < ActiveRecord::Base  
+  attr_reader :notifier
+    
+end

data/lib/model/mongoid/active_meta.rb

@@ -0,0 +1,6 @@
+class ActiveMeta
+  include Mongoid::Document
+  field :document_id, type: Integer
+  has_many :labels, :class_name => "Label"
+  index :document_id
+end

data/lib/model/mongoid/attachment.rb

@@ -0,0 +1,25 @@
+class Attachment
+  include Mongoid::Document
+  include Mongoid::Paperclip
+
+  belongs_to :label
+  has_mongoid_attached_file :attach,
+      :path  => "#{ActiveMetadata::CONFIG['attachment_base_path']}/:document_id/:label/:counter/:basename.:extension",
+      :url  => "#{ActiveMetadata::CONFIG['attachment_base_url']}/:document_id/:label/:counter/:basename.:extension"
+
+  field :created_by, :type => Integer
+  field :counter, :type => Integer
+
+  Paperclip.interpolates :document_id do |attachment,style|
+   attachment.instance.label.active_meta.document_id
+  end
+
+  Paperclip.interpolates :label do |attachment,style|
+    attachment.instance.label.name
+  end
+
+  Paperclip.interpolates :counter do |attachment,style|
+    attachment.instance.counter
+  end
+
+end

data/lib/model/mongoid/history.rb

@@ -0,0 +1,9 @@
+class History
+  include Mongoid::Document
+  store_in :history
+  
+  belongs_to :label
+
+  field :value, :type => String
+
+end

data/lib/model/mongoid/label.rb

@@ -0,0 +1,14 @@
+class Label
+  include Mongoid::Document  
+  field :name
+  
+  belongs_to :active_meta, :class_name => "ActiveMeta"
+  
+  has_many :notes, :class_name => "Note"
+  has_many :histories, :class_name => "History"
+  has_many :attachments, :class_name => "Attachment"
+  has_many :watchers, :class_name => "Watcher"
+  
+  index :name
+  
+end

data/lib/model/mongoid/note.rb

@@ -0,0 +1,10 @@
+class Note
+  include Mongoid::Document
+  belongs_to :label
+
+  field :note, :type => String
+  field :updated_by, :type => Integer
+  field :updated_at, :type => Time 
+  
+  index :updated_at  
+end

data/lib/model/mongoid/watcher.rb

@@ -0,0 +1,24 @@
+class Watcher
+  include Mongoid::Document
+
+  belongs_to :label
+
+  field :owner_id, :type => Integer
+
+  def notify_changes(matched_label, old_value, new_value, model_class, model_id)
+    create_inbox_alert(User.find(owner_id).inbox, matched_label, old_value, new_value, model_class, model_id)
+  end
+
+  def create_inbox_alert(inbox, label, old_value, new_value, model_class, model_id)
+    Message.create! do |message|
+      message.label = label
+      message.model_class = model_class.to_s
+      message.model_id = model_id
+      message.alert_type = :model_value_changed
+      message.old_value = old_value
+      message.new_value = new_value
+      message.inbox_id = inbox.id
+      message.read = false
+    end 
+  end
+end

data/lib/rails/railties/tasks.rake

@@ -0,0 +1,8 @@
+namespace :cheese do
+  
+  desc "example gem rake task"
+  task :report => :environment do
+    puts "you just ran the example gem rake task"
+  end
+
+end

data/lib/rake/active_record_tasks.rb

@@ -0,0 +1,77 @@
+require 'yaml'
+require 'logger'
+require 'active_record'
+
+namespace :db do
+  def create_database config
+    options = {:charset => 'utf8', :collation => 'utf8_unicode_ci'}
+
+    create_db = lambda do |config|
+      ActiveRecord::Base.establish_connection config.merge('database' => nil)
+      ActiveRecord::Base.connection.create_database config['database'], options
+      ActiveRecord::Base.establish_connection config
+    end
+
+    begin
+      create_db.call config
+    rescue Mysql::Error => sqlerr
+      if sqlerr.errno == 1405
+        print "#{sqlerr.error}. \nPlease provide the root password for your mysql installation\n>"
+        root_password = $stdin.gets.strip
+
+        grant_statement = <<-SQL
+          GRANT ALL PRIVILEGES ON #{config['database']}.* 
+            TO '#{config['username']}'@'localhost'
+            IDENTIFIED BY '#{config['password']}' WITH GRANT OPTION;
+        SQL
+
+        create_db.call config.merge('database' => nil, 'username' => 'root', 'password' => root_password)
+      else
+        $stderr.puts sqlerr.error
+        $stderr.puts "Couldn't create database for #{config.inspect}, charset: utf8, collation: utf8_unicode_ci"
+        $stderr.puts "(if you set the charset manually, make sure you have a matching collation)" if config['charset']
+      end
+    end
+  end
+ 
+  task :environment do
+    DATABASE_ENV = ENV['DATABASE_ENV'] || 'development'
+    MIGRATIONS_DIR = ENV['MIGRATIONS_DIR'] || 'db/migrate'
+  end
+
+  task :configuration => :environment do
+    @config = YAML.load_file('config/database.yml')[DATABASE_ENV]
+  end
+
+  task :configure_connection => :configuration do
+    ActiveRecord::Base.establish_connection @config
+    ActiveRecord::Base.logger = Logger.new STDOUT if @config['logger']
+  end
+
+  desc 'Create the database from config/database.yml for the current DATABASE_ENV'
+  task :create => :configure_connection do
+    create_database @config
+  end
+
+  desc 'Drops the database for the current DATABASE_ENV'
+  task :drop => :configure_connection do
+    ActiveRecord::Base.connection.drop_database @config['database']
+  end
+
+  desc 'Migrate the database (options: VERSION=x, VERBOSE=false).'
+  task :migrate => :configure_connection do
+    ActiveRecord::Migration.verbose = true
+    ActiveRecord::Migrator.migrate MIGRATIONS_DIR, ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+  end
+
+  desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
+  task :rollback => :configure_connection do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+    ActiveRecord::Migrator.rollback MIGRATIONS_DIR, step
+  end
+
+  desc "Retrieves the current schema version number"
+  task :version => :configure_connection do
+    puts "Current version: #{ActiveRecord::Migrator.current_version}"
+  end
+end

data/lib/rake/task.rb

@@ -0,0 +1,18 @@
+require 'rake'
+require 'fileutils'
+
+namespace :active_metadata do
+  task :install do
+    #FileUtils.cp File.expand_path('../../templates/mongoid.yml',__FILE__), File.expand_path('config/')
+    #puts "Installed mongoid.yml"
+
+    FileUtils.cp File.expand_path('../../templates/active_metadata.yml',__FILE__), File.expand_path('config/')
+    puts "Installed active_metadata.yml"
+
+    puts "Copying migrations"
+    ts = Time.now.utc.strftime('%Y%m%d%H%M%S')
+    FileUtils.cp File.expand_path('../../templates/active_metadata_migrations',__FILE__), File.expand_path("db/migrate/#{ts}_active_metadata_migrations.rb")
+    puts "run rake db:migrate to complete the gem installation"    
+
+  end
+end

data/lib/templates/active_metadata.yml

@@ -0,0 +1,17 @@
+development:
+    persists_with: "active_record"
+    history_skip_fields:
+      - 'id'
+      - 'created_at'
+      - 'updated_at'
+    attachment_base_path: "public/system/metadata_attachments"
+    attachment_base_url: "/system/metadata_attachments"
+
+test:
+    persists_with: "active_record"
+    history_skip_fields:
+      - 'id'
+      - 'created_at'
+      - 'updated_at'
+    attachment_base_path: "public/system/metadata_attachments"
+    attachment_base_url: "/system/metadata_attachments"

data/lib/templates/active_metadata_migrations

@@ -0,0 +1,67 @@
+class ActiveMetadataMigrations < ActiveRecord::Migration
+  def self.up
+
+    create_table :notes do |t|
+      t.text :note
+      t.string :label
+      t.integer :document_id
+      t.integer :created_by
+      t.integer :updated_by      
+      t.timestamps
+    end
+
+    add_index :notes, :document_id
+    add_index :notes, :label
+    add_index :notes, :updated_at
+
+    create_table :histories do |t|
+      t.text :value
+      t.string :label
+      t.integer :document_id
+      t.integer :created_by
+      t.timestamps
+    end
+
+    add_index :histories, :document_id
+    add_index :histories, :label
+    add_index :histories, :created_at
+
+    create_table :attachments do |t|
+      t.string :label
+      t.integer :document_id
+      t.integer :created_by
+      t.integer :updated_by
+      t.integer :counter
+      t.string :attach_file_name
+      t.string :attach_content_type
+      t.integer :attach_file_size
+      t.datetime :attach_updated_at
+      t.timestamps
+    end
+
+    add_index :attachments, :document_id
+    add_index :attachments, :label
+    add_index :attachments, :attach_updated_at
+
+    create_table :watchers do |t|
+      t.integer :owner_id
+      t.string :label
+      t.integer :document_id
+      t.timestamps
+    end
+
+    add_index :watchers, :document_id
+    add_index :watchers, :label
+    add_index :watchers, :owner_id
+    add_index :watchers, :created_at
+        
+  end
+
+  def self.down
+    drop_table :notes
+    drop_table :histories
+	drop_table :attachments
+	drop_table :watchers
+  end
+
+end

data/lib/templates/mongoid.yml

@@ -0,0 +1,20 @@
+development:
+  host: localhost
+  database: metadata_d
+
+test:
+  host: localhost
+  database: metadata_t
+
+# set these environment variables on your prod server
+production:
+  host: <%= ENV['MONGOID_HOST'] %>
+  port: <%= ENV['MONGOID_PORT'] %>
+  username: <%= ENV['MONGOID_USERNAME'] %>
+  password: <%= ENV['MONGOID_PASSWORD'] %>
+  database: <%= ENV['MONGOID_DATABASE'] %>
+  # slaves:
+  #   - host: slave1.local
+  #     port: 27018
+  #   - host: slave2.local
+  #     port: 27019