neo4jrb-paperclip 0.0.1-jruby

data/README.md

@@ -0,0 +1,43 @@
+Neo4jrb::Paperclip - Making Paperclip play nice with Neo4j.rb
+================================================================
+
+This gem is based on [mongoid-paperclip 0.0.4](https://github.com/meskyanichi/mongoid-paperclip).
+
+As the title suggests: `Mongoid::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.
+
+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,90 @@
+# encoding: utf-8
+
+begin
+  require "paperclip"
+rescue LoadError
+  puts "Neo4jrb::Paperclip requires that you install the Paperclip gem."
+  exit
+end
+
+##
+# Use Neo4j's logger.
+module Paperclip
+  class << self
+    def logger
+      Neo4j::Config[:logger]
+    end
+  end
+end
+
+
+##
+# The Neo4jrb::Paperclip extension
+# Makes Paperclip play nice with the Neo4j Models
+#
+# Example:
+#
+#  class User < 
+#    include Neo4jrb::Paperclip
+#
+#    has_neo4jrb_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_neo4jrb_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", Neo4jrb::Paperclip automatically adds the neccesary "fields"
+# to your Model (MongoDB collection) when you invoke the "#has_neo4jrb_attached_file" method. When you invoke "has_neo4jrb_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 => Fixnum
+#  field :avatar_updated_at,   :type => DateTime
+#
+module Neo4jrb 
+  module Paperclip
+
+    ##
+    # Extends the model with the defined Class methods
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      ##
+      # Adds Neo4jrb::Paperclip's "#has_neo4jrb_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_neo4jrb_attached_file(field, options = {})
+
+        ##
+        # Include Paperclip and Paperclip::Glue for compatibility
+        include ::Paperclip
+        include ::Paperclip::Glue
+
+        ##
+        # Invoke Paperclip's #has_attached_file method and passes in the
+        # arguments specified by the user that invoked Neo4jrb::Paperclip#has_neo4jrb_attached_file
+        has_attached_file(field, options)
+
+        ##
+        # Define the necessary collection fields in Neo4jrb for Paperclip
+        property :"#{field}_file_name",    :type => String
+        property :"#{field}_content_type", :type => String
+        property :"#{field}_file_size",    :type => Fixnum 
+        property :"#{field}_updated_at",   :type => DateTime
+      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/neo4jrb-paperclip.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+
+  gem.name        = 'neo4jrb-paperclip'
+  gem.version     = '0.0.1'
+  gem.platform    = "jruby"
+  gem.authors     = 'Leo Lou'
+  gem.email       = 'louyuhong@gmail.com'
+  gem.homepage    = 'https://github.com/l4u/neo4jrb-paperclip'
+  gem.summary     = 'Neo4jrb::Paperclip enables you to use Paperclip with Neo4j.rb'
+  gem.description = 'Neo4jrb::Paperclip enables you to use Paperclip with Neo4j.rb'
+
+  gem.files         = %x[git ls-files].split("\n")
+  gem.test_files    = %x[git ls-files -- {spec}/*].split("\n")
+  gem.require_path  = 'lib'
+
+  gem.add_dependency 'paperclip', ['~> 2.3.6']
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: neo4jrb-paperclip
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: jruby
+authors: 
+  - Leo Lou
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-17 00:00:00 +08:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: paperclip
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 2.3.6
+    type: :runtime
+    version_requirements: *id001
+description: Neo4jrb::Paperclip enables you to use Paperclip with Neo4j.rb
+email: louyuhong@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - README.md
+  - lib/neo4jrb_paperclip.rb
+  - neo4jrb-paperclip.gemspec
+has_rdoc: true
+homepage: https://github.com/l4u/neo4jrb-paperclip
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: Neo4jrb::Paperclip enables you to use Paperclip with Neo4j.rb
+test_files: []
+