magick_filter 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b3a2361a449784dd6949a417b5f22101bd1baf8d0674adb6e2a8b94feb8f36b
-  data.tar.gz: 87b2d1e05c9e2cc97f10d59a354ca1e9cd4f41c53810ae6fc635b8c8996adc6e
+  metadata.gz: 36c322301310dfd866e7bbecf09ae6d062a04c2889f5b4a02957aeefe16ed4cc
+  data.tar.gz: 229a25a1f93307f45471a2d58f2bf455dbb88b31d7839968b87a6dc3eab58df8
 SHA512:
-  metadata.gz: 9d85ee44518ef7450ef9c802749b59d1ac169b972b6c60865f9d0a748124f4b11abf990bb1eeccb1a79adcae95508945c52ec0955ff404731213375303c595fd
-  data.tar.gz: 5723f31c9c3ffb090cda30e13d4cdce470d11db12197bd6531ebed5083e3ef9df222d83dc46fc832be72ef80c2c69c0712e059c8c970ae1743eab3259db5b223
+  metadata.gz: e43fe24963e37da68e5a50353b5b39f0812b466234e9b70f59026c09be778487a0413d95b617ee8b30bf4ffc564f4adedb165f8a886c16c2a433f212485d3677
+  data.tar.gz: 650d3e679ae154013b82bc4e0667119a36aa05c24d6d5e8f4c25d3e11d9559411915b40ebbe5019f2c0e4afaa622c2b57b1b87246249fa9629b1b7712adc09b2

data/README.md

@@ -2,7 +2,7 @@
 
 # MagickFilter
 
-A powerful yet very simple to use gem to apply all sorts of cool instagram types of filters to your images or photos in your Ruby on Rails application. With this gem you can use all sorts of filters like Poster, Sepia, Navy, Sketch etc. You can apply frames of different colours to your images or photos as well.
+A powerful yet very simple to use gem to apply all sorts of cool instagram types of filters to your images or photos in your Ruby on Rails application. With this gem you can use all sorts of filters like Poster, Sepia, Navy, Sketch etc. You can apply frames of different types of frames with different colours to your images or photos as well.
 
 This Gem is an attempt to build Ruby Gem and release it to [rubygems.org](https://rubygems.org). Latest version of this gem allows you to add frame to existing photo. This Gem is in early stage. I'll keep on adding some more filters and features with time. 
 
@@ -26,20 +26,40 @@ Or install it yourself as:
     $ gem install magick_filter
 
 ## Usage
-1. Latest version of this Gem supports adding frame to photo with different colors. You can choose any desired color for frame from [ImageMagick color list](https://www.imagemagick.org/script/color.php)
+1. Latest version of this Gem supports adding frames to photo with different colors. You can choose any desired color for frame from [ImageMagick color list](https://www.imagemagick.org/script/color.php)
+	```ruby
+	MagickFilter::Tool.apply_frame(image_path, frame_color, frame_type)	
+	```    
+
+    ```ruby
+    a) Option 1st => Basic Frame
+    MagickFilter::Tool.apply_frame(image_path, "snow", "basic")
+    b) Option 2nd => Sunken Frame
+    MagickFilter::Tool.apply_frame(image_path, "snow", "sunken")			 
+    ```
     ```ruby
-	a) MagickFilter::Tool.apply_frame(image_path, "snow")
-	b) MagickFilter::Tool.apply_frame(image_path, "LightPink")
-	c) MagickFilter::Tool.apply_frame(image_path, "SlateBlue1")
-	d) MagickFilter::Tool.apply_frame(image_path, "SpringGreen4")
+    Different color options example - 
+	a) MagickFilter::Tool.apply_frame(image_path, "snow", "basic")
+	b) MagickFilter::Tool.apply_frame(image_path, "LightPink", "BASIC")
+	c) MagickFilter::Tool.apply_frame(image_path, "SlateBlue1", :basic)
     ```
+
+### Default frame type is "basic", frame_type is case insensitive. You can add "basic", "BASIC" or :basic    
+
 2. In present there are 12 filters available in this Gem. Use the given below commands ( from Filter Examples section ) on console to convert photos.
+    ```ruby
+    MagickFilter::Tool.process(image_path, filter_type)
+    ```
+
     ```ruby
 	a) MagickFilter::Tool.process(image_path, "sketch")
-	b) MagickFilter::Tool.process(image_path, "bright")
-	c) MagickFilter::Tool.process(image_path, "sepia")
+	b) MagickFilter::Tool.process(image_path, "BRIGHT")
+	c) MagickFilter::Tool.process(image_path, :sepia)
 	d) MagickFilter::Tool.process(image_path, "rough")
     ```
+
+### Filter type is case insensitive, you can add "sketch", "SKETCH" or :sketch  
+
 ## Frame Examples
 
 ### Original Image
@@ -47,33 +67,33 @@ Or install it yourself as:
 <img src="/test_image/test.jpg" alt="Original" width=450 height=298 />
 
 
-### Snow Color Frame
+### Snow Color Frame with basic frame
 
-**`MagickFilter::Tool.apply_frame(image_path, "snow")`**
+**`MagickFilter::Tool.apply_frame(image_path, "snow", "basic")`**
 
 
 <img src="/test_image/snow.jpg" alt="snow" width=450 height=298 />
 
 
-### LightPink Color Frame
+### LightPink Color Frame with sunken frame
 
-**`MagickFilter::Tool.apply_frame(image_path, "LightPink")`**
+**`MagickFilter::Tool.apply_frame(image_path, "LightPink", "sunken")`**
 
 
 <img src="/test_image/lightpink.jpg" alt="LightPink" width=450 height=298 />
 
 
-### Orchid1 Color Frame
+### Orchid1 Color Frame with basic frame
 
-**`MagickFilter::Tool.apply_frame(image_path, "orchid1")`**
+**`MagickFilter::Tool.apply_frame(image_path, "orchid1", "basic")`**
 
 
 <img src="/test_image/orchid1.jpg" alt="orchid1" width=450 height=298 />
 
 
-### SlateBlue1 Color Frame
+### SlateBlue1 Color Frame with sunken frame
 
-**`MagickFilter::Tool.apply_frame(image_path, "SlateBlue1")`**
+**`MagickFilter::Tool.apply_frame(image_path, "SlateBlue1", "sunken")`**
 
 
 <img src="/test_image/slateblue1.jpg" alt="SlateBlue1" width=450 height=298 />

data/lib/filter.rb

@@ -12,9 +12,10 @@ module Filter
  	              rough: "-dither FloydSteinberg -colors 8",
  	              sepia: "-sepia-tone 80%"}
 
- 	FRAME_TYPE = "-mattecolor Tomato -frame 20x20+10+10"              
+ 	FRAME_TYPE = {basic: "-mattecolor Tomato -frame 20x20+10+10", sunken: "-mattecolor Tomato -frame 20x20+0+20" }              
+
+	WRITE_PATH = "/tmp" 
 
-	WRITE_PATH = "/tmp" 	
 end
 
 

data/lib/magick_filter.rb

@@ -1,91 +1,95 @@
 require "magick_filter/version"
 require "filter"
- 
+
 module MagickFilter
   class Tool
-	  	def self.process(path='', effect='')
-	    	parameter_missing?(path, effect)
-	        parse_if_image(path)
-	        out_file = build_out_file_name(path)
-	        out_file = cmd_convert(path, out_file, effect)
-	    end
+    def self.process(path='', effect='')
+      parameter_missing?(path, effect, "effect")
+      parse_if_image(path)
+      out_file = build_out_file_name(path)
+      out_file = cmd_convert(path, out_file, effect)
+    end
+
+    def self.apply_frame(path='', color_type='', frame_style=nil)
+      parameter_missing?(path, color_type, "frame")
+      parse_if_image(path)
+      out_file = build_out_file_name(path)
+      out_file = cmd_convert_frame(path, out_file, color_type, frame_style)
+    end
+
+    def self.root
+      File.expand_path('../..',__FILE__)
+    end
 
-	    def self.apply_frame(path='', color_type='')
-	    	parameter_missing?(path, color_type)
-	        parse_if_image(path)
-	        out_file = build_out_file_name(path)
-	        out_file = cmd_convert_frame(path, out_file, color_type)
-	    end
+    private
 
-	    def self.root
-	    	File.expand_path('../..',__FILE__)
-	  	end
- 
-      private
+    def self.parse_if_image(path)
+      file_ext = IO.popen(["file", "--brief", "--mime-type", path], &:read).chomp.split("/").last
+      if ["jpeg", "png", "jpg", "JPG", "PNG"].include?(file_ext)
+        return true
+      else
+        raise "**********Provided file isn't a valid Image**********" 
+      end
+    end
 
-	    def self.parse_if_image(path)
-	    	file_ext = IO.popen(["file", "--brief", "--mime-type", path], &:read).chomp.split("/").last
-	    	if ["jpeg", "png", "jpg", "JPG", "PNG"].include?(file_ext)
-	    		return true
-	    	else
-	    		raise "**********Provided file isn't a valid Image**********" 
-	    	end
-	    end
+    def self.parameter_missing?(path, effect, called_for)
+    	err = ''
+  		if path.blank? && effect.blank?
+      	err = "***************Image Path and Effect or Frame Color Parameter Missing***********"
+    	elsif path.blank?
+      	err = "***************Image Path Missing***********"
+    	elsif effect.blank?
+      	err = "***************Effect or Frame Color Parameter Missing***********"
+    	end	
+      if err.blank? 
+      	return false 
+ 			else
+ 				raise "#{err}"
+ 			end	
+    end
 
-	    def self.parameter_missing?(path, effect)
-	    	if path.blank? && effect.blank?
-	    		err = "***************Image Path and Effect Parameter Missing***********"
-	    	elsif path.blank?
-	    		err = "***************Image Path Missing***********"
-	    	elsif effect.blank?
-	    		err = "***************Effect Parameter Missing***********"
-	    	end	
-	    	return false
-	    	raise err
-	    end
+    def self.cmd(bin, opts)
+      #puts "executing: #{c}"
+      #system("sudo " << c)  	
+      "#{bin} #{opts}".tap do |c|
+        system(c)      
+      end
+    end
 
-	    def self.cmd(bin, opts)
-	    	"#{bin} #{opts}".tap do |c|
-	      		#puts "executing: #{c}"
-	      		#system("sudo " << c)  
-	      		system(c)      
-	    	end
-	    end
+    def self.cmd_convert(in_file=nil, out_file=nil, opts)
+      #in_file ||= current_source_file
+      #out_file ||= current_target_file
+      cmd(:convert, "#{in_file} #{get_effect_options(opts)} #{out_file}")
+      print "***Your Image is available here to copy at desired location*** - #{out_file}"
+      return out_file
+    end
 
-	    def self.cmd_convert(in_file=nil, out_file=nil, opts)
-	    	#in_file ||= current_source_file
-	    	#out_file ||= current_target_file
-	    	cmd(:convert, "#{in_file} #{get_effect_options(opts)} #{out_file}")
-	    	print "***Your file is available here to copy in desired location*** - #{out_file}"
-	    	return out_file
-	    end
+    def self.cmd_convert_frame(in_file=nil, out_file=nil, opt1, opt2)
+      cmd(:convert, "#{in_file} #{get_frame_type(opt1, opt2)} #{out_file}")
+      print "***Your Image is available here to copy at desired location*** - #{out_file}"
+      return out_file
+    end
 
-	     def self.cmd_convert_frame(in_file=nil, out_file=nil, opts)
-	    	#in_file ||= current_source_file
-	    	#out_file ||= current_target_file
-	    	cmd(:convert, "#{in_file} #{get_frame_type(opts)} #{out_file}")
-	    	print "***Your file is available here to copy in desired location*** - #{out_file}"
-	    	return out_file
-	    end
+    def self.build_out_file_name(path)
+      return "#{Filter::WRITE_PATH}/#{next_uuid}_output.#{get_file_extension(path)}"
+    end
 
-	    def self.build_out_file_name(path)
-	      return "#{Filter::WRITE_PATH}/#{next_uuid}_output.#{get_file_extension(path)}"
-	    end
+    def self.get_file_extension(path)
+      File.extname(path).strip.downcase[1..-1]
+    end
 
-	    def self.get_file_extension(path)
-	    	File.extname(path).strip.downcase[1..-1]
-	    end
+    def self.next_uuid
+      rand(36**16).to_s(36)
+    end
 
-	    def self.next_uuid
-	    	rand(36**16).to_s(36)
-	    end
-		
-		def self.get_effect_options(effect)
-			Filter::EFFECT_MAP[effect.downcase.to_sym]
-		end
+    def self.get_effect_options(effect)
+      Filter::EFFECT_MAP[effect.downcase.to_sym]
+    end
 
-		def self.get_frame_type(color_type)
-			Filter::FRAME_TYPE.gsub("Tomato", color_type)
-		end
+    def self.get_frame_type(color_type, frame_style)
+    	frame_style ||= "basic"
+    	frame_type = Filter::FRAME_TYPE[frame_style.downcase.to_sym]
+      frame_type = frame_type.gsub("Tomato", color_type)
+    end
   end
 end

data/lib/magick_filter/version.rb

@@ -1,4 +1,4 @@
 module MagickFilter
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end
 

data/magick_filter.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["er.arvind02@gmail.com"]
 
   spec.summary       = %q{Apply Filters or Frames on Photo or Image}
-  spec.description   = %q{A powerful yet very simple to use gem to apply all sorts of cool instagram types of filters to your images or photos in your Ruby on Rails application. With this gem you can use all sorts of filters like Poster, Sepia, Navy, Sketch etc. You can apply frames of different colours to your images or photos. Pick any colour for frames from https://www.imagemagick.org/script/color.php }
+  spec.description   = %q{A powerful yet very simple to use gem to apply all sorts of cool instagram types of filters to your images or photos in your Ruby on Rails application. With this gem you can use all sorts of filters like Poster, Sepia, Navy, Sketch etc. You can apply frames ( In present tow types of frames ) of different colours to your images or photos. Pick any colour for frames from https://www.imagemagick.org/script/color.php }
   spec.homepage      = "https://github.com/arvind02/magick_filter"
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magick_filter
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - arvind02
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,8 +55,8 @@ dependencies:
 description: 'A powerful yet very simple to use gem to apply all sorts of cool instagram
   types of filters to your images or photos in your Ruby on Rails application. With
   this gem you can use all sorts of filters like Poster, Sepia, Navy, Sketch etc.
-  You can apply frames of different colours to your images or photos. Pick any colour
-  for frames from https://www.imagemagick.org/script/color.php '
+  You can apply frames ( In present tow types of frames ) of different colours to
+  your images or photos. Pick any colour for frames from https://www.imagemagick.org/script/color.php '
 email:
 - er.arvind02@gmail.com
 executables: []