refile-postgres 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e67a83492371a4bbdac7474951277a515bc1f836
-  data.tar.gz: 73ec8fb7a9d4ebdfd49522175bc7ccd2d075ad6b
+  metadata.gz: fb79dfe21ef11e8e168357f538f2a4c51a83095b
+  data.tar.gz: 66d562ee82b791458b122d3eb950d660a28144c8
 SHA512:
-  metadata.gz: d2f9cdb78006f2fb7f8e3abf6ec066f77733a1d1a1107671837ff67fd9650762c00beaa49372b718b7e8c8f93a6f8f107897dd7bcac3f6988c30f1ceb5cb452e
-  data.tar.gz: a73cfb197b8f2d2a6611a2abaa722741876cec5d91101bfae778bc952c2a3f239cac4a703b3371218e884bc67ec00bd4605017d206f43295c4cb8e3be770023d
+  metadata.gz: 450be3febecd24b2856bb9429166ba94f66aabff229b0056aeae0d5d5103a604295d23d95ced7ce381518fd31a20615d78551f4f30797866bbf7c0a9bb0ca41b
+  data.tar.gz: b5d83e96ccf67e3e046430215db09a513265ef5ae6c73227cb283b5a2c4d51a8015bf558b0859336592610f83513e07d90b6f886c8085f039bd628dbdf15261d

data/README.md

@@ -1,6 +1,18 @@
 # Refile::Postgres
 
-TODO: Write a gem description
+A PostgreSQL backend for [Refile](https://github.com/elabs/refile).
+
+## Why?
+
+* You want to store all your data in one place to simplify backups and replication
+* ACID
+
+## Take into account
+
+* Gem is developed and tested using Postgresql 9.3, Ruby 2.1 and ActiveRecord 4.x. It might work with earlier versions.
+* Performance hit storing files in database
+* Higher memory requirements for database
+* Backups can take significantly longer
 
 ## Installation
 
@@ -24,7 +36,7 @@ TODO: Write usage instructions here
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/refile-postgres/fork )
+1. Fork it ( https://github.com/krists/refile-postgres/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/generators/refile/postgres/initializer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates initializer and sets Postgres as store backend
+
+Example:
+    rails generate initializer
+
+    This will create:
+        config/initializers/refile.rb

data/lib/generators/refile/postgres/initializer/initializer_generator.rb

@@ -0,0 +1,6 @@
+class Refile::Postgres::InitializerGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  def copy_initializer_file
+    copy_file "refile.rb", "config/initializers/refile.rb"
+  end
+end

data/lib/generators/refile/postgres/initializer/templates/refile.rb

@@ -0,0 +1,4 @@
+require "refile"
+Refile.configure do |config|
+  config.store = Refile::Postgres::Backend.new(ActiveRecord::Base.connection.raw_connection)
+end

data/lib/generators/refile/postgres/migration/USAGE

@@ -0,0 +1,8 @@
+Description:
+Generates database migration for table to story list of attachments
+
+Example:
+    rails generate refile:postgres:migration
+
+    This will create:
+        db/migrate/<timestamp>_create_refile_attachments.rb

data/lib/generators/refile/postgres/migration/migration_generator.rb

@@ -0,0 +1,15 @@
+require "refile"
+require 'rails/generators/active_record'
+class Refile::Postgres::MigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  argument :table_name, type: :string, default: Refile::Postgres::Backend::DEFAULT_REGISTRY_TABLE
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def copy_migration_file
+    migration_template "migration.rb.erb", "db/migrate/create_#{table_name}.rb"
+  end
+end

data/lib/generators/refile/postgres/migration/templates/migration.rb.erb

@@ -0,0 +1,14 @@
+class Create<%= table_name.camelize %> < ActiveRecord::Migration
+  def up
+    create_table :<%= table_name %> do |t|
+      t.string :namespace, null: false
+    end
+    add_index :<%= table_name %>, :namespace
+  end
+
+  def drop
+    remove_index :<%= table_name %>, :namespace
+    drop_table :<%= table_name %>
+  end
+end
+

data/lib/refile/postgres/backend/reader.rb

@@ -2,7 +2,7 @@ module Refile
   module Postgres
     class Backend
       class Reader
-        PQTRANS_INTRANS = 2 # (idle, within transaction block)
+        include SmartTransaction
 
         def initialize(connection, oid)
           @connection = connection
@@ -50,29 +50,6 @@ module Refile
           @closed = true
         end
 
-        private
-
-        def smart_transaction
-          result = nil
-          ensure_in_transaction do
-            begin
-              handle = connection.lo_open(oid)
-              result = yield handle
-              connection.lo_close(handle)
-            end
-          end
-          result
-        end
-
-        def ensure_in_transaction
-          if connection.transaction_status == PQTRANS_INTRANS
-            yield
-          else
-            connection.transaction do
-              yield
-            end
-          end
-        end
       end
     end
   end

data/lib/refile/postgres/backend.rb

@@ -1,14 +1,28 @@
 module Refile
   module Postgres
     class Backend
+      include SmartTransaction
+      RegistryTableDoesNotExistError = Class.new(StandardError)
       DEFAULT_REGISTRY_TABLE = "refile_attachments"
       DEFAULT_NAMESPACE = "default"
       PG_LARGE_OBJECT_TABLE = "pg_largeobject"
+
       def initialize(connection, max_size: nil, namespace: DEFAULT_NAMESPACE, registry_table: DEFAULT_REGISTRY_TABLE)
+        unless connection.is_a?(PG::Connection)
+          raise ArgumentError.new("First argument should be an instance of PG::Connection. When using ActiveRecord its available in ActiveRecord::Base.connection.raw_connection")
+        end
         @connection = connection
         @namespace = namespace.to_s
         @registry_table = registry_table
         @max_size = max_size
+        connection.exec %{
+          SELECT count(*) from pg_catalog.pg_tables
+          WHERE tablename = '#{@registry_table}';
+        } do |result|
+          unless result[0]["count"].to_i > 0
+            raise RegistryTableDoesNotExistError.new(%{Please create a table "#{@registry_table}" where backend could store list of attachments})
+          end
+        end
       end
 
       attr_reader :connection, :namespace, :registry_table
@@ -16,7 +30,7 @@ module Refile
       def upload(uploadable)
         Refile.verify_uploadable(uploadable, @max_size)
         oid = connection.lo_creat
-        connection.transaction do
+        ensure_in_transaction do
           begin
             handle = connection.lo_open(oid, PG::INV_WRITE)
             connection.lo_truncate(handle, 0)
@@ -72,7 +86,7 @@ module Refile
 
       def delete(id)
         if exists?(id)
-          connection.transaction do
+          ensure_in_transaction do
             connection.lo_unlink(id.to_s.to_i)
             connection.exec_params("DELETE FROM #{registry_table} WHERE id = $1::integer;", [id])
           end
@@ -81,7 +95,7 @@ module Refile
 
       def clear!(confirm = nil)
         raise ArgumentError, "are you sure? this will remove all files in the backend, call as `clear!(:confirm)` if you're sure you want to do this" unless confirm == :confirm
-        connection.transaction do
+        ensure_in_transaction do
           connection.exec_params(%{
             SELECT * FROM #{registry_table}
             INNER JOIN #{PG_LARGE_OBJECT_TABLE} ON #{registry_table}.id = #{PG_LARGE_OBJECT_TABLE}.loid

data/lib/refile/postgres/smart_transaction.rb

@@ -0,0 +1,31 @@
+module Refile
+  module Postgres
+    module SmartTransaction
+
+      PQTRANS_INTRANS = 2 # (idle, within transaction block)
+
+      def smart_transaction
+        result = nil
+        ensure_in_transaction do
+          begin
+            handle = connection.lo_open(oid)
+            result = yield handle
+            connection.lo_close(handle)
+          end
+        end
+        result
+      end
+
+      def ensure_in_transaction
+        if connection.transaction_status == PQTRANS_INTRANS
+          yield
+        else
+          connection.transaction do
+            yield
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/refile/postgres/version.rb

@@ -1,5 +1,5 @@
 module Refile
   module Postgres
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/refile/postgres.rb

@@ -1,4 +1,5 @@
 require "refile/postgres/version"
+require "refile/postgres/smart_transaction"
 require "refile/postgres/backend"
 require "refile/postgres/backend/reader"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refile-postgres
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Krists Ozols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refile
@@ -121,9 +121,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/refile/postgres/initializer/USAGE
+- lib/generators/refile/postgres/initializer/initializer_generator.rb
+- lib/generators/refile/postgres/initializer/templates/refile.rb
+- lib/generators/refile/postgres/migration/USAGE
+- lib/generators/refile/postgres/migration/migration_generator.rb
+- lib/generators/refile/postgres/migration/templates/migration.rb.erb
 - lib/refile/postgres.rb
 - lib/refile/postgres/backend.rb
 - lib/refile/postgres/backend/reader.rb
+- lib/refile/postgres/smart_transaction.rb
 - lib/refile/postgres/version.rb
 - refile-postgres.gemspec
 - spec/refile/postgres/backend_spec.rb