photofy 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b77a6f420026f5be340cdae42a22fef7dacd205
-  data.tar.gz: ad949b60783be2bf604004e3da3f46d29d72a67c
+  metadata.gz: 52ab5edb906bec6b8f3d9dc4d6382740671ca69b
+  data.tar.gz: a5f6b32dbdc932e35084c5f3f367b6da561c37a1
 SHA512:
-  metadata.gz: 6ab2fac1d174909231104eac8ef113267fcf331c9597ec92b2f93d23d20b3b11120a722e1f7b9b17a6aec9dfd93cb7ed89ddb5ed3a3c3153f7184e89a73bd33d
-  data.tar.gz: 67902b5c082d0ae0ef80b7da58cbe48acc90349671cd9120c457db4aa1ac56757185417cf75a2047b0d973717459e973d5b0c64b09a2f35cdc083891abb5affe
+  metadata.gz: c86f938112502f3f6bf340fea7c36eaf915ca5a530a65ff05509f8dbaa2290cf51418c7705086dbc9be74b8449cccbf816479fd6d6ad2eac7c9e74908174ed4d
+  data.tar.gz: fe44b3c6a2f6a6af4dc35a469d0ff0fd3eaa7c68bad31a2b3350028f9f40ed80fce866714a8502a09963ce4a5cc2fa7b1c93b5f0713835190366cffad225b9dc

data/README.md

@@ -0,0 +1,44 @@
+## Photofy
+A simple ruby gem providing photo fields to rails model
+
+## Installation
+Add this line to your application's Gemfile:
+
+`gem 'photofy'`
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install photofy`
+
+
+## Usage
+Add photo field(s) to model by adding lines like
+
+`photofy(:collage)`
+
+> * `collage` : Getter,
+> * `collage?` : Returns true if assignment is having value other than nil else false,
+> * `collage =` : Setter. Acceptable inputs are file upload(ActionDispatch::Http::UploadedFile), file and String(format validation is ignored),
+> * `collage_path` : File path of assignment,
+> * `collage_s3publicpath` : Public aws s3 url provider if (aws s3 is used as storage)
+> * `collage_persisted?` : Gives true if provided file/data is stored on disk,
+> * `collage_store!` : To store provided file/data on disk,
+> * `collage_destroy!` : To destroy stored file/data from disk
+
+
+`photofy(:collage_sec, {parent_photo_field: :collage})`
+> Automatically creates a collage_sec photo field from :collage parent field
+
+`photofy(:stamp, {image_processor: Proc.new { |img| img.scale(25, 25) }})`
+> Process image to scale(refer imagemagick/rmagick for other image manipulations) of 25x25px when image is saved.
+
+`after_photofy :collage, :post_card, Proc.new { |img| img.scale(450, 200) }`
+> Creates 'post_card' photo field by taking source from 'collage' and scaling it to 450x200px.
+
+Enables aws s3 as backend storage (may be in initializer).
+
+`ActiveRecord::Base.photofy_s3_storage({access_key_id: 'xxxxxxxx',secret_access_key: 'xxxxxxxx'}, {bucket: 'test_bucket'})`

data/lib/photofy/core.rb

@@ -1,13 +1,12 @@
 module Photofy
   module Core
-    attr_accessor :photofied_flag
-    attr_accessor :photo_fields
-    attr_accessor :photos_repository
-    attr_accessor :photo_formats
+    cattr_accessor :photofied_flag
+    cattr_accessor :photo_fields
+    cattr_accessor :photo_formats
 
     #Getter to check if model is enabled with file_folder
     def is_photofied?
-      @photofied_flag.nil? ? false : @photofied_flag
+      @@photofied_flag.nil? ? false : @@photofied_flag
     end
 
     #Generates photo field which can be used to store a post processed image(using rmagick) of parent photo field.
@@ -55,8 +54,8 @@ module Photofy
 
       self.validate "validate_#{photo_field}_field"
 
-      @photo_fields ||=[]
-      @photo_fields << photo_field
+      @@photo_fields ||=[]
+      @@photo_fields << photo_field
 
       define_method "validate_#{photo_field}_field" do
         (@photo_fields_errors ||={}).each do |field, message|
@@ -253,18 +252,18 @@ module Photofy
       send(:after_save, "#{photo_field}_store!")
       send(:after_destroy, "#{photo_field}_destroy!")
 
-      @photofied_flag = true
+      @@photofied_flag = true
     end
 
     def photos_repository
-      @photos_repository ||= FileUtils.mkdir_p(File.join(Rails.root, "photofy", self.name))[0]
+      FileUtils.mkdir_p(File.join(Rails.root, "photofy", self.name.underscore))[0]
     end
 
     #Collects valid photo formats specific to photo fields
     def collect_photo_formats(photo_field, options)
       if options.is_a?(Hash)
-        @photo_formats ||= {}
-        @photo_formats[photo_field] = options[:formats].is_a?(Array) ? options[:formats].collect { |x| x.starts_with?(".") ? x : ".#{x}" } : [".jpeg", ".jpg", ".gif", ".png", ".bmp"]
+        @@photo_formats ||= {}
+        @@photo_formats[photo_field] = options[:formats].is_a?(Array) ? options[:formats].collect { |x| x.starts_with?(".") ? x : ".#{x}" } : [".jpeg", ".jpg", ".gif", ".png", ".bmp"]
       else
         raise 'InvalidArguments'
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: photofy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.5
 platform: ruby
 authors:
 - Praveen Kumar Sinha
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -34,23 +34,13 @@ dependencies:
         version: 1.49.0
 description: |2
       A gem to provide simple method to do file upload of pictures and provides getter setter methods of it and save on model object commit.
-
-        #Generates photo filed from photo_field arguments and provides methods like
-        #if photo_filed is "collage" then it provides methods on top of it as
-        #collage >> Getter,
-        #collage? >> Returns true if assignment is having value other than nil else false,
-        #collage =  >> Setter. Acceptable inputs are file upload(ActionDispatch::Http::UploadedFile), filer handle and String(format validation is ignored),
-        #collage_path >> File path of assignment,
-        collage_s3publicpath >> Public aws s3 url provider if (aws s3 is used as storage),
-        #collage_path_to_write >> File path of assignment to write (specific to writing. Used internally),
-        #collage_persisted? >> true if provided file/data is stored on disk,
-        #collage_store! >> to store provided  file/data on disk,
-        #collage_destroy! >> to store destroy stored file/data from disk
+      Refer documentation for more help.
 email: praveen.kumar.sinha@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/photofy.rb
 - lib/photofy/core.rb
 - lib/photofy/s3methods.rb