paperclip-neo4j 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ad0402253d77d6515dfa32cdff07cff36cd2231
+  data.tar.gz: 74f07db5b05951ef31b43b8b27e8c8c8e22062f3
+SHA512:
+  metadata.gz: 3cadf773200f9b2620cb3eb7d039ce31401a55000d85298b30dc0a9bb21649997ac295a0165534a285852d96c9877ab7dfc36bfbe0ed144d1d28806a18ba9415
+  data.tar.gz: be84b74f50eb1de0587d257cb80c871526ce1efef4f5a06c87cb76ede52cc3c7377b1140a2276207702043fd786a31482bf32751bef14a78f36e1db22f17bbca

data/README.md

@@ -0,0 +1,49 @@
+Neo4jrb::Paperclip - Making Paperclip play nice with Neo4j.rb
+================================================================
+This gem is based on [neo4jrb-paperclip 0.0.4](https://github.com/l4u/neo4jrb-paperclip.git).
+
+This gem is based on [mongoid-paperclip 0.0.4](https://github.com/meskyanichi/mongoid-paperclip).
+
+As the title suggests: `Neo4jrb::Paperclip` makes it easy to hook up [Paperclip](https://github.com/thoughtbot/paperclip) with [Neo4j.rb](https://github.com/andreasronge/neo4j).
+
+This is actually easier and faster to set up than when using Paperclip and the ActiveRecord ORM.
+This example assumes you are using **Ruby on Rails 3** and **Bundler**. However it doesn't require either.
+
+
+Setting it up
+-------------
+
+Make sure you are using JRuby. Simply define the `neo4jrb-paperclip` gem inside your `Gemfile`. Additionally, you can define the `aws-s3` gem if you want to upload your files to Amazon S3. *You do not need to explicitly define the `paperclip` gem itself, since this is handled by `neo4jrb-paperclip`.*
+
+**Rails.root/Gemfile - Just define the following:**
+
+    gem "neo4jrb-paperclip", :require => "neo4jrb_paperclip"
+    gem "aws-s3",            :require => "aws/s3"
+
+Next let's assume we have a User model and we want to allow our users to upload an avatar.
+
+**Rails.root/app/models/user.rb - include the Neo4jrb::Paperclip module and invoke the provided class method**
+
+    class User < Neo4j::Rails::Model
+      include Neo4jrb::Paperclip
+
+      has_neo4jrb_attached_file :avatar
+    end
+
+
+That's it
+--------
+
+That's all you have to do. Users can now upload avatars. Unlike ActiveRecord, Neo4j doesn't use migrations normally, so we don't need to define the Paperclip columns in a separate file. Invoking the `has_neo4jrb_attached_file` method will automatically define the necessary `:avatar` fields for you in the background.
+
+Known issues
+------------
+
+File size returns 0 - [paperclip issue](https://github.com/thoughtbot/paperclip/issues/100)
+
+Related Links
+------------
+
+* [mongoid-paperclip](https://github.com/meskyanichi/mongoid-paperclip)
+* [Neo4j.rb](https://github.com/andreasronge/neo4j)
+* [Paperclip](https://github.com/thoughtbot/paperclip) 

data/lib/neo4jrb_paperclip.rb

@@ -0,0 +1,112 @@
+begin
+  require "paperclip"
+rescue LoadError
+  puts "Neo4jrb::Paperclip requires that you install the Paperclip gem."
+  exit
+end
+
+##
+# mongoid criteria uses a different syntax.
+module Paperclip
+  module Helpers
+    def each_instance_with_attachment(klass, name)
+      class_for(klass).unscoped.where("#{name}_file_name".to_sym.ne => nil).each do |instance|
+        yield(instance)
+      end
+    end
+  end
+end
+
+##
+# The Mongoid::Paperclip extension
+# Makes Paperclip play nice with the Mongoid ODM
+#
+# Example:
+#
+#  class User
+#    include Mongoid::Document
+#    include Mongoid::Paperclip
+#
+#    has_mongoid_attached_file :avatar
+#  end
+#
+# The above example is all you need to do. This will load the Paperclip library into the User model
+# and add the "has_mongoid_attached_file" class method. Provide this method with the same values as you would
+# when using "vanilla Paperclip". The first parameter is a symbol [:field] and the second parameter is a hash of options [options = {}].
+#
+# Unlike Paperclip for ActiveRecord, since MongoDB does not use "schema" or "migrations", Mongoid::Paperclip automatically adds the neccesary "fields"
+# to your Model (MongoDB collection) when you invoke the "#has_mongoid_attached_file" method. When you invoke "has_mongoid_attached_file :avatar" it will
+# automatially add the following fields:
+#
+#  field :avatar_file_name,    :type => String
+#  field :avatar_content_type, :type => String
+#  field :avatar_file_size,    :type => Integer
+#  field :avatar_updated_at,   :type => DateTime
+#  field :avatar_fingerprint,  :type => String
+#
+module Neo4jrb 
+  module Paperclip
+
+    ##
+    # Extends the model with the defined Class methods
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+    
+      ##
+      # Adds after_commit
+      def after_commit(*args, &block)
+        options = args.pop if args.last.is_a? Hash
+        if options
+          case options[:on]
+          when :create
+            after_create(*args, &block)
+          when :update
+            after_update(*args, &block)
+          when :destroy
+            after_destroy(*args, &block)
+          else
+            after_save(*args, &block)
+          end
+        else
+          after_save(*args, &block)
+        end
+      end
+      ##
+      # Adds Neo4jrb::Paperclip's "#has_neo4j_attached_file" class method to the model
+      # which includes Paperclip and Paperclip::Glue in to the model. Additionally
+      # it'll also add the required fields for Paperclip since MongoDB is schemaless and doesn't
+      # have migrations.
+      def has_neo4j_attached_file(field, options = {})
+        ##
+        # Include Paperclip and Paperclip::Glue for compatibility
+        unless self.ancestors.include?(::Paperclip)
+          include ::Paperclip
+          include ::Paperclip::Glue
+        end
+
+        ##
+        # Invoke Paperclip's #has_attached_file method and passes in the
+        # arguments specified by the user that invoked Neo4jrb::Paperclip#has_neo4j_attached_file
+        has_attached_file(field, options)
+
+        ##
+        # Define the necessary collection fields in Mongoid for Paperclip
+        property :"#{field}_file_name",    :type => String
+        property :"#{field}_content_type", :type => String
+        property :"#{field}_file_size",    :type => Integer
+        property :"#{field}_updated_at",   :type => DateTime
+        property :"#{field}_fingerprint",  :type => String
+      end
+
+      ##
+      # This method is deprecated
+      def has_attached_file(field, options = {})
+        raise "Neo4jrb::Paperclip#has_attached_file is deprecated, " +
+          "Use 'has_neo4jrb_attached_file' instead"
+      end
+    end
+  end
+end

data/paperclip-neo4j.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+
+  gem.name        = 'paperclip-neo4j'
+  gem.version     = '1.0.0'
+  # gem.platform    = "ruby"
+  gem.authors     = 'Kieran Lafferty'
+  gem.email       = 'kieran.lafferty@gmail.com'
+  gem.homepage    = 'https://github.com/KieranLafferty/paperclip-neo4j'
+  gem.summary     = 'Allow paperclip to work with Neo4j'
+  gem.description = 'Allows paperclip to upload files nicely with Neo4j'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_path  = ["lib"]
+
+  gem.add_dependency 'paperclip'
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-neo4j
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kieran Lafferty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows paperclip to upload files nicely with Neo4j
+email: kieran.lafferty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/neo4jrb_paperclip.rb
+- paperclip-neo4j.gemspec
+homepage: https://github.com/KieranLafferty/paperclip-neo4j
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- - lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allow paperclip to work with Neo4j
+test_files: []