tmp 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 055f0f73e75681b686ca70e9f0f1d14a5a5e538e
-  data.tar.gz: 59134acb4673a4e3db9cab1ef9e62774dbf6f350
+  metadata.gz: b631c6e7a79b483feccd10c0e15f5caaf7bea6c4
+  data.tar.gz: 65b2540c73ab7ff7cd95a99a1a0c582a7ccba7b9
 SHA512:
-  metadata.gz: 4723c10dd21a5c3fb86d7a08cd6eeafa7d0d4508114642b0e2fd98c9b7d3d20c4d5a9194d6d9640c5f78cbddeb0adb984bec4d7c3d91470c3fb2dea3da9e9cb1
-  data.tar.gz: e76e9e3553c2103edaed60a65741a14e5a7a6e7864fc67a649a6490890bfa792bf96ad10a74f642cb34bfa31538223dd27d137942e2a524c234739f26089eefe
+  metadata.gz: b4ffef273b67015028956c76226467e25316b82480491c97f4ca1a500458dc9bd0c46493f5e0ec179a3f82e0d6a488a59e2dc3c120b4838f28faff3a0e111fd2
+  data.tar.gz: 7d66305aefb0bee6deb2d0337459bddb910bf11285eed5880e5ec092454c6340499399a6c35f2da7eca5120031dade04f3d68786da0e7a57e24ec3fc0f485a9d

data/Gemfile.lock

@@ -1,13 +1,11 @@
 PATH
   remote: .
   specs:
-    tmp (1.3.0)
-      empty_object
+    tmp (2.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    empty_object (1.0.0)
     rake (10.2.2)
 
 PLATFORMS

data/README.md

@@ -1,30 +1,42 @@
-tmp
+TMP
 ===
 
-Ruby DSL for manage tmp files and make easy
-tmp commands / variables to file system
-Sometimes usefull for forked processes.
+Ruby DSL for temporally files read/write in the object oriented way (system tmp).
+Manage tmp files in the super easy way!
 
-I'ts not made for shared memory management!
-The main goal is to provide dsl for easy tmp files making on the filesystem
+This dsl let you have simply way to commands and create variables on file system,
+by default in the actual systems (cross platform) tmp folder.
+
+Sometimes it can be useful for multi processing (forked processes),
+but the main goal is not made for shared memory management!
+The goal is to provide dsl for easy tmp files making on the filesystem in the object oriented way
+(real objects and not simply strings)
+
+By default i's always IO work and not memory,
+everything you save with this will be IO command and not memory management
 
 
 ### Example
 
+In the Examples i will use most likely the 'tmp' name, what is a syntax sugar
+The real object(module) being called all the time is the TMP::DSL
+The DSL will make easy the job on you but you can use the default methods alike:
+
+* TMP.write( file_name, object )
+* TMP.read( file_name ) #> object
+
 ```ruby
-    require 'tmp'
 
-    TMP.write :test, {hello: 'world'}
-    puts TMP.read(:test)
+    require 'tmp'
 
-    # or you can use syntax sugar!
     tmp.hello = { hello: 'world'}
 
     # defined variable
-    puts tmp.hello #> { hello: 'world'}
+    tmp.hello #> { hello: 'world'}
 
     # undefined variable
-    puts tmp.sup #> nil
+    tmp.sup #> nil
+
 ```
 
 ### Config
@@ -32,14 +44,19 @@ The main goal is to provide dsl for easy tmp files making on the filesystem
 you can config the folder path for custom tmp folder use case if you dont want to use the systems default tmp folder/ your app space
 
 ```ruby
+
     require 'tmp'
 
-    TMP::Config.folder_path File.expand_path(File.join(File.dirname(__FILE__),'tmp_folder'))
+    # set folder path if we dont want to use
+    # the default system_tmp/our_project_folder_name/
+    TMP.folder_path "/super/awesome/path/to/my/wished/folder"
+
+    # to check what is the default folder path just use this
+    TMP.default_folder_path #> return default path
+
+    # to check the current path use this
+    TMP.folder_path #> return the current path
 
-    # or you can use syntax sugar!
-    tmp.hello = { hello: 'world'}
-    # defined variable
-    puts tmp.hello #> { hello: 'world'}
 ```
 
 ### Remove tmp objects
@@ -47,20 +64,22 @@ you can config the folder path for custom tmp folder use case if you dont want t
 you can remove tmp objects by purge them
 
 ```ruby
+
     require 'tmp'
 
     tmp.hello = { hello: 'world'}
 
     # now it's set
-    puts tmp.hello #> { hello: 'world'}
+    tmp.hello #> { hello: 'world'} -> hash obj
 
     TMP.purge!
 
     # now it's nil
-    puts tmp.hello #> nil
+    tmp.hello #> nil
+
 ```
 
-### Instance use case
+### Instance use case for modules or separated tmp folders
 
 if you want use as an instance for example for your very own module, than you can do this
 
@@ -68,21 +87,109 @@ if you want use as an instance for example for your very own module, than you ca
 
     require 'tmp'
 
+
     tmp_instance= TMP.new( File.expand_path(File.join(File.dirname(__FILE__),'tmp_folder')) )
 
+    # use the same as the TMP::DSL aka tmp method
+
+    # let's set a string for this one
     tmp_instance.test= "hello"
 
-    # get the instance test variable
-    puts tmp_instance.test.inspect #> this must be "hello"
+    # get the string what we just set now
+    tmp_instance.test #> "hello"
+
+    # you can get the tmp class instance obj like this:
+    tmp_instance.tmp_class_instance_object #> return the tmp_instance
+
+    # return the tmp folder path
+    tmp_instance.tmp_class_instance_object.folder_path
+
+    # Remember this instance use different folder thant the main TMP::DSL
+    tmp.test.inspect  #> nil, because it was never used before
+                      #> the tmp method is same like invoke the TMP::DSL module
+
+
+```
+
+### Blocks for file commands
+
+using blocks is nothing like cupcake in Ruby, and just alike in this dsl
+
+
+```ruby
+
+    require 'tmp'
+
+    # using blocks is simply as this
+    tmp.some_file_name do |file|
+      file.write Random.rand(100...1000)
+    end
+
+    # reopen the new file is also simple
+    tmp.some_file_name do |file|
+
+      while line = file.gets
+        puts line
+      end
+
+      file.write Random.rand(100...1000)
+
+    end
+
+    # you can set the file mod if you like, by default it's based on file e
+    tmp.some_file_name "w+" do |file|
+
+      while line = file.gets
+        puts line
+      end
+      # totaly nothing writed out to console because the "w+"
+
+      file.write "hello world!"
+
+    end
+
+    puts tmp.some_file_name #> it's a string from the file we made
+
+```
+
+### File mod cheat sheet
+
+```ruby
 
-    # get the main TMP test variable
-    puts tmp.test.inspect  #> must be nil because it was never used before
-                           #> same as TMP::DSL.test.inspect
+    #
+    # Mode |  Meaning
+    # -----+--------------------------------------------------------
+    # "r"  |  Read-only, starts at beginning of file  (default mode).
+    # -----+--------------------------------------------------------
+    # "r+" |  Read-write, starts at beginning of file.
+    # -----+--------------------------------------------------------
+    # "w"  |  Write-only, truncates existing file
+    #      |  to zero length or creates a new file for writing.
+    # -----+--------------------------------------------------------
+    # "w+" |  Read-write, truncates existing file to zero length
+    #      |  or creates a new file for reading and writing.
+    #     -----+--------------------------------------------------------
+    # "a"  |  Write-only, starts at end of file if file exists,
+    #      |  otherwise creates a new file for writing.
+    # -----+--------------------------------------------------------
+    # "a+" |  Read-write, starts at end of file if file exists,
+    #      |  otherwise creates a new file for reading and
+    #      |  writing.
+    # -----+--------------------------------------------------------
+    #  "b" |  Binary file mode (may appear with
+    #      |  any of the key letters listed above).
+    #      |  Suppresses EOL <-> CRLF conversion on Windows. And
+    #      |  sets external encoding to ASCII-8BIT unless explicitly
+    #      |  specified.
+    # -----+--------------------------------------------------------
+    #  "t" |  Text file mode (may appear with
+    #      |  any of the key letters listed above except "b").
+    #
 
 ```
 
 ### TODO
 
-* make ssl encryption for the tmp files opt able
+* make ssl encryption or chmod persm change for the tmp files protection as options
 * implement more awesome trick
 * find contributors

data/VERSION

@@ -1 +1 @@
-1.3.0
+2.0.0

data/examples/blocks.rb

@@ -0,0 +1,31 @@
+require 'tmp'
+
+# using blocks is simply as this
+tmp.some_file_name do |file|
+  file.write Random.rand(100...1000)
+end
+
+# reopen the new file is also simple
+tmp.some_file_name do |file|
+
+  while line = file.gets
+    puts line
+  end
+
+  file.write Random.rand(100...1000)
+
+end
+
+# you can set the file mod if you like, by default it's based on file e
+tmp.some_file_name "w+" do |file|
+
+  while line = file.gets
+    puts line
+  end
+  # totaly nothing writed out to console because the "w+"
+
+  file.write "hello world!"
+
+end
+
+puts tmp.some_file_name #> it's a string from the file we made

data/examples/config_exmpl.rb

@@ -1,9 +1,23 @@
 require 'tmp'
 
-TMP::Config.folder_path File.expand_path(File.join(File.dirname(__FILE__),'tmp_folder'))
+TMP.folder_path File.expand_path(File.join(File.dirname(__FILE__),'tmp_folder'))
+
+# except the default folder path, everything is opt able
+puts "","default tmp folder:",
+     TMP.default_folder_path,"",
+
+     "new tmp folder for use:",
+     TMP.folder_path,"",
+
+     "the project name what is used:",
+     TMP.project_name,""
+
+# you can trigger the tmp folder generating by the following
+TMP.folder_init #> || tmp_folder_init
 
 # or you can use syntax sugar!
 tmp.hello = { hello: 'world'}
+
 # defined variable
 puts tmp.hello #> { hello: 'world'}
 

data/examples/instance.rb

@@ -1,12 +1,22 @@
 require 'tmp'
 
+
 tmp_instance= TMP.new( File.expand_path(File.join(File.dirname(__FILE__),'tmp_folder')) )
 
+# use the same as the TMP::DSL aka tmp method
+
+# let's set a string for this one
 tmp_instance.test= "hello"
 
-# get the instance test variable
-puts tmp_instance.test.inspect #> this must be "hello"
+# get the string what we just set now
+tmp_instance.test #> "hello"
+
+# you can get the tmp class instance obj like this:
+tmp_instance.tmp_class_instance_object #> return the tmp_instance
+
+# return the tmp folder path
+tmp_instance.tmp_class_instance_object.folder_path
 
-# get the main TMP test variable
-puts tmp.test.inspect  #> must be nil because it was never used before
-                       #> same as TMP::DSL.test.inspect
+# Remember this instance use different folder thant the main TMP::DSL
+tmp.test.inspect  #> nil, because it was never used before
+                  #> the tmp method is same like invoke the TMP::DSL module

data/examples/sugar_use.rb

@@ -0,0 +1,22 @@
+require 'tmp'
+
+TMP.write :test2, {hello: 'world'}
+puts TMP.read(:test2)
+
+#or you can use syntax sugar!
+tmp.hello= { hello: 'world'}
+
+tmp.hello do |hello|
+  puts 'world'
+end
+
+# defined variable
+puts tmp.hello #> { hello: 'world'}
+
+# undefined variable
+puts tmp.sup #> nil
+
+TMP.purge!
+
+# call after tmp is purged
+puts tmp.hello #> nil

data/examples/test.rb

@@ -1,18 +1 @@
-require 'tmp'
-
-TMP.write :test, {hello: 'world'}
-puts TMP.read(:test)
-
-# or you can use syntax sugar!
-tmp.hello = { hello: 'world'}
-
-# defined variable
-puts tmp.hello #> { hello: 'world'}
-
-# undefined variable
-puts tmp.sup #> nil
-
-TMP.purge!
-
-# call after tmp is purged
-puts tmp.hello #> nil
+# all set! :)

data/lib/tmp.rb

@@ -1,8 +1,9 @@
 #encoding: UTF-8
 
 require 'tmpdir'
-require 'empty_object'
 
 require 'tmp/core'
+require 'tmp/sup'
+
 require 'tmp/dsl'
 require 'tmp/init'

data/lib/tmp/core.rb

@@ -3,8 +3,24 @@ module TMP
 
   module CORE
 
+    def project_name name_string= nil
+
+      unless name_string.nil?
+
+        unless name_string.class <= String
+          raise ArgumentError,"invalid name string"
+        end
+
+        @project_name = name_string
+
+      end
+
+      @project_name || Dir.pwd.split(File::Separator).last.to_s
+
+    end
+
     def default_folder_path
-      File.join( Dir.tmpdir, ( Dir.pwd.split(File::Separator).last.to_s  ) )
+      File.join( Dir.tmpdir , project_name )
     end
 
     @folder_path= nil
@@ -39,6 +55,8 @@ module TMP
 
     end
 
+    alias :folder_init :tmp_folder_init
+
     def write variable_name, data_object
 
       tmp_folder_init

data/lib/tmp/dsl.rb

@@ -1,23 +1,59 @@
 #encoding: UTF-8
 module TMP
 
+
   module DSLCore
 
-    def method_missing( method, *args )
-      @class_name ||= ::TMP
+    def target_obj obj=nil
+
+      unless obj.nil?
+        @target_obj= obj
+      end
+
+      @target_obj || ::TMP
+
+    end
+
+    def method_missing( method, *args, &block )
+
+      @target_methods = [:write,:read,:file]
 
       if method.to_s.include?('=')
-        @class_name.write( method.to_s.gsub('=',''), args.first )
+        target_obj.__send__ @target_methods[0], method.to_s.gsub('=',''), args.first
       else
-        @class_name.read( method )
+
+        unless block.nil?
+
+          if File.exist? File.join( target_obj.folder_path, method.to_s )
+            args[0] ||= "r+"
+          else
+            args[0] ||= "w+"
+          end
+
+          File.open( File.join( target_obj.folder_path, method.to_s ), args[0] ,&block)
+
+        else
+
+          begin
+            target_obj.__send__ @target_methods[1], method
+          rescue TypeError
+            File.open(File.join( target_obj.folder_path, method.to_s ),"r").read
+          end
+
+        end
+
       end
 
     end
 
   end
 
-  class DSL < ::EmptyObject
+  module DSL
+
+    extend ObjectExt
     extend DSLCore
+    privatize
+
   end
 
   module SyntaxSugar
@@ -26,6 +62,8 @@ module TMP
       ::TMP::DSL
     end
 
+    alias :temporally :tmp
+
   end
 
 end

data/lib/tmp/init.rb

@@ -11,17 +11,28 @@ module TMP
         raise ArgumentError, "path must be a string like type"
       end
 
-      tmp_folder_path path_string
+      folder_path path_string
 
     end
 
   end
 
-  class InstanceDSL < ::EmptyObject
+  class InstanceDSL
+
+    extend ObjectExt
     include DSLCore
 
     def initialize path_string
-      @class_name = InstanceCore.new path_string
+      target_obj InstanceCore.new( path_string )
+    end
+
+    privatize t: 'instance'
+
+    public
+
+
+    def tmp_class_instance_object
+      target_obj
     end
 
   end
@@ -31,7 +42,6 @@ module TMP
     def new *args
       InstanceDSL.new *args
     end
-
     alias :init :new
 
   end

data/lib/tmp/sup.rb

@@ -0,0 +1,92 @@
+#encoding: UTF-8
+module TMP
+
+  module ObjectExt
+
+    def privatize opts= {}
+
+      unless opts.class <= Hash
+        raise ArgumentError,"invalid input for options"
+      end
+
+      %W[ e ex exc ].each do |str_sym|
+        opts[:exclude] ||= opts[str_sym.to_sym]
+      end
+
+      %W[ i in inc only methods ].each do |str_sym|
+        opts[:include] ||= opts[str_sym.to_sym]
+      end
+
+      %W[ t target ].each do |str_sym|
+        opts[:target] ||= opts[str_sym.to_sym]
+      end
+
+      opts[:target] ||= 's'
+      opts[:target]= opts[:target].to_s.downcase
+
+      unless opts[:target][0] == "s" || opts[:target][0] == "i"
+        %W[ singleton instance ].include?(opts[:target].to_s)
+        raise ArgumentError, [
+            "invalid options for target, you should use the following: ",
+            "\n\tsingleton for targeting the singleton class what is de",
+            "fault\n\tinstance for targeting the object instance methods."
+        ].join
+      end
+
+      opts[:exclude] ||= []
+
+      if opts[:target][0] == 'i' && self.class <= Module
+        opts[:include] ||= self.instance_methods.map{|e| e.to_s }
+      else
+        opts[:target]= 's'
+        opts[:include] ||= self.methods.map{|e| e.to_s }
+
+      end
+
+      [:include,:exclude].each do |array_name|
+
+        unless opts[array_name].class <= Array
+          opts[array_name]= [ opts[array_name] ]
+        end
+
+        opts[array_name].map!{ |element| ( element.class == String ? element : element.to_s ) }
+
+      end
+
+      opts[:exclude].push('__send__').push('object_id')
+
+      if opts[:target][0] == 's'
+
+        self.instance_eval do
+
+          opts[:include].each do |sym|
+
+            unless opts[:exclude].include?(sym)
+              (class << self; self; end).__send__ :private, sym
+            end
+
+          end
+        end
+
+      elsif opts[:target][0] == 'i'
+
+        opts[:include].each do |sym|
+
+          unless opts[:exclude].include?(sym)
+            self.__send__ :private, sym
+          end
+
+        end
+
+      else
+        STDERR.puts "invalid target definition"
+
+      end
+
+
+    end
+
+  end
+
+
+end

data/tmp.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.version       = File.open(File.join(File.dirname(__FILE__),"VERSION")).read.split("\n")[0].chomp.gsub(' ','')
   spec.authors       = ["Adam Luzsi"]
   spec.email         = ["adamluzsi@gmail.com"]
-  spec.description   = %q{ Ruby DSL for manage tmp files and make easy tmp commands / variables to file system. Sometimes usefull for forked processes. I'ts not made for shared memory management! The main goal is to provide dsl for easy tmp files making on the filesystem }
-  spec.summary       = %q{ DSL for system temporary folder to save objects }
+  spec.description   = %q{ DSL for temporally files read/write in the object oriented way (system tmp). Manage tmp files in the super easy way! This dsl let you have simply way to commands and create variables on file system by default in the actual systems (cross platform) tmp folder. Sometimes it can be useful for multi processing (forked processes), but the main goal is not made for shared memory management! The goal is to provide dsl for easy tmp files making on the filesystem in the object oriented way (real objects and not simply strings). By default i's always IO work and not memory, everything you save with this will be IO command and not memory }
+  spec.summary       = %q{ DSL for temporally files read/write in the object oriented way (system tmp) }
   spec.homepage      = "https://github.com/adamluzsi/tmp"
   spec.license       = "MIT"
 
@@ -19,8 +19,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'empty_object'
-
   %W[ rake bundler ].each{ |gem_name| spec.add_development_dependency(gem_name) }
 
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: tmp
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: empty_object
-  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,10 +38,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: " Ruby DSL for manage tmp files and make easy tmp commands / variables
-  to file system. Sometimes usefull for forked processes. I'ts not made for shared
-  memory management! The main goal is to provide dsl for easy tmp files making on
-  the filesystem "
+description: " DSL for temporally files read/write in the object oriented way (system
+  tmp). Manage tmp files in the super easy way! This dsl let you have simply way to
+  commands and create variables on file system by default in the actual systems (cross
+  platform) tmp folder. Sometimes it can be useful for multi processing (forked processes),
+  but the main goal is not made for shared memory management! The goal is to provide
+  dsl for easy tmp files making on the filesystem in the object oriented way (real
+  objects and not simply strings). By default i's always IO work and not memory, everything
+  you save with this will be IO command and not memory "
 email:
 - adamluzsi@gmail.com
 executables: []
@@ -68,8 +58,10 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- examples/blocks.rb
 - examples/config_exmpl.rb
 - examples/instance.rb
+- examples/sugar_use.rb
 - examples/test.rb
 - examples/tmp_folder/test
 - files.rb
@@ -77,6 +69,7 @@ files:
 - lib/tmp/core.rb
 - lib/tmp/dsl.rb
 - lib/tmp/init.rb
+- lib/tmp/sup.rb
 - tmp.gemspec
 homepage: https://github.com/adamluzsi/tmp
 licenses:
@@ -101,5 +94,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: DSL for system temporary folder to save objects
+summary: DSL for temporally files read/write in the object oriented way (system tmp)
 test_files: []