save_file 1.0.34

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc78eddefce9f749a9e6e996bc4958c8aa343bb8dc0dd2a8c8be2aecf0c79f52
+  data.tar.gz: 0c34e0af5b8b6f546f745e8596c6223a239d2ada17a31a49137257512a6cb817
+SHA512:
+  metadata.gz: ba40495683e416e3f9774f72e2089bf57ed7dff73a1a1108572ad79d3207a4cd96485656f9718e16cbd3f4f999cf57315b70e3d1402384d9f65711fdc68f3776
+  data.tar.gz: 59ea539111364707f60ddd1f42adf591908d3573ef8efa8233b3bbd4df04ff7b2582cda6a9629a6609520bdf9fe1b5ebf13c2125166e241fb2c170294156c3a3

data/README.md

@@ -0,0 +1,25 @@
+This gem provides a save_file() method functionality.
+
+In other words, you can save a file with this easily.
+
+I often needed a save_file() functionality among my 
+different projects, so that is why I turned this into
+a standalone gem, rather than writing a new save_file() 
+functionality every time anew for my projects.
+
+That functionality is bundled into a module called
+SaveFile. Additionally, convenience methods called
+save_file() and append_what_into() are provided, 
+and of course several aliases to these.
+
+You can pass the permission bits as third argument
+to the two main methods of this gem:
+
+  - save_file()
+  - append_what_into()
+
+Also note that:
+
+  - write_what_into()
+
+is an alias to save_file().

data/lib/save_file/append/append_what_into.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'save_file/module/save_file.rb' # This will also pull in constants.rb
+
+# =========================================================================== #
+# === append_what_into
+#
+# A wrapper over the save functionality above. Currently we do not
+# make use of the permission bits, but this may change at a later
+# time.
+#
+# For this to work, we need to require the SaveFile module.
+#
+# Usage example:
+#   append_what_into()
+# =========================================================================== #
+def append_what_into(
+    what              = "Testing.\n",
+    into_where        = 'default.txt',
+    permission_to_use = SaveFile::DEFAULT_PERMISSION_TO_USE
+  )
+  ::SaveFile.append_what_into(what, into_where, permission_to_use)
+end; alias append_what_to           append_what_into # === append_what_to
+     alias append_into              append_what_into # === append_into
+     alias append_file              append_what_into # === append_file
+     alias append_into_file         append_what_into # === append_into_file
+     alias append_what_into_file    append_what_into # === append_what_into_file
+     alias append_what_to_this_file append_what_into # === append_what_to_this_file

data/lib/save_file/autoinclude.rb

@@ -0,0 +1,2 @@
+require 'save_file' # Add the default save_file require here.
+include SaveFile

data/lib/save_file/base/base.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This is the class-variant from which you can subclass, if you need
+# a specialized class that already has this functionality.
+# =========================================================================== #
+# require 'save_file/base/base.rb'
+# =========================================================================== #
+module SaveFile
+
+class SaveFile
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    reset
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === write_what_into
+  # ========================================================================= #
+  def write_what_into(
+      what = "Hello world!\n",
+      into = 'default_test_file.md'
+    )
+    ::SaveFile.write_what_into(what, into)
+  end
+
+end
+
+# =========================================================================== #
+# === SaveFile.new
+# =========================================================================== #
+def self.new
+  ::SaveFile::SaveFile.new
+end
+
+end

data/lib/save_file/constants.rb

@@ -0,0 +1,22 @@
+
+
+
+
+
+# =========================================================================== #
+# This file holds the constants that we will use in the save_file gem.
+# =========================================================================== #
+module SaveFile # require 'save_file/constants.rb'
+
+  # ========================================================================= #
+  # Specify the file mode to be used here.
+  # ========================================================================= #
+  FILE_MODE_TO_BE_USED = 'w+'
+
+  # ========================================================================= #
+  # === SAVE_FILE_WHERE_TO
+  # ========================================================================= #
+  SAVE_FILE_WHERE_TO   = 'default.txt'
+  DEFAULT_PERMISSION_TO_USE = 0755
+
+end

data/lib/save_file/module/save_file.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file holds the main module of SaveFile. It requires the file
+# constants.rb.
+# =========================================================================== #
+# require 'save_file/module/save_file.rb'
+# =========================================================================== #
+module SaveFile
+
+  require 'save_file/constants.rb' # Pull in 3 constants from that file.
+
+  alias e puts
+
+  # ========================================================================= #
+  # === save_file
+  #
+  # Use this method to save a file in your ruby projects.
+  # 
+  # The arguments to this method are the following:
+  #
+  #   (1) what
+  #   (2) into_where
+  #   (3) the permission to use for the newly created file
+  #   (4) file mode to use
+  #   
+  # The second argument, `into_where`, is the target file that will
+  # be created or stored-into. For instance, 'test.txt'
+  #
+  # As of Dec 2013, the third argument is the permission bit.
+  #
+  # The fourth argument is the file mode to be used, which we
+  # default to the 'w+' mode. If you require append-functionality,
+  # it is recommended to use the append_into() or append_file()
+  # method, which can be found in this file as well, below the 
+  # save_file() method.
+  # ========================================================================= #
+  def save_file(
+      what                 = "Testing.\n",              # What we will save.
+      into_where           = SAVE_FILE_WHERE_TO,        # Save into this file here.
+      permission_to_use    = DEFAULT_PERMISSION_TO_USE, # With these permissions.
+      file_mode_to_be_used = FILE_MODE_TO_BE_USED       # The file mode to be used. Can also be a Symbol such as :overwrite
+    )
+
+    into_where = into_where.to_s
+    if    file_mode_to_be_used == :overwrite
+      file_mode_to_be_used = 'w+'
+    elsif file_mode_to_be_used == :append
+      file_mode_to_be_used = 'a+'
+    end
+    # ======================================================================= #
+    # Next handle Array input. Unsure whether we should join via \n or
+    # not. Dec 2013 I decided that we join via '', and not via "\n".
+    # ======================================================================= #
+    if what.is_a? Array
+      what = what.join('') # ("\n")
+    end
+    if File.directory? into_where
+      into_where = sfile(into_where) if respond_to? :sfile
+      e 'Sorry, can not store into '+into_where
+      e 'as it is a directory.'
+    end
+    case permission_to_use
+    when :default
+      permission_to_use = DEFAULT_PERMISSION_TO_USE
+    end
+    if permission_to_use.is_a? String # File.open() does not like Strings, hence convert them.
+       case permission_to_use
+       when 'w' # We assume the user made a mistake here.
+         file_mode_to_be_used = 'w'
+         permission_to_use = DEFAULT_PERMISSION_TO_USE
+       else # Else we treat it like an Octal.
+         permission_to_use = permission_to_use.to_i(8)
+       end
+    elsif permission_to_use.nil?
+       permission_to_use = DEFAULT_PERMISSION_TO_USE
+    end
+    if permission_to_use == :append
+      permission_to_use = DEFAULT_PERMISSION_TO_USE
+    elsif permission_to_use.is_a? Symbol # If that is the case then we assume an error happened.
+      permission_to_use = DEFAULT_PERMISSION_TO_USE
+    end
+    file_mode_to_be_used = file_mode_to_be_used.to_s
+    begin
+      Signal.trap('SIGINT') { exit }
+      # ===================================================================== #
+      # If we are appending then we are effectively doing this:
+      #   File.open('myfile.out','a') {|f| f.puts "Hello, world." }
+      # ===================================================================== #
+      File.open(into_where, file_mode_to_be_used, permission_to_use) {|file|
+        file.write(what) # Write the new file here.
+      } # The aliases to it here.
+    rescue Errno::EINVAL
+      if into_where.include? '-' # Then try again.
+        into_where = into_where.split('-').first
+      end
+      File.open(into_where, file_mode_to_be_used, permission_to_use) {|file|
+        file.write(what) # Write the new file here.
+      }
+    rescue Errno::EACCES
+      into_where = sfile(into_where) if respond_to? :sfile
+      error_string = 'You do not have sufficient permission '+
+      'to write into '+into_where+'.'
+      e error_string
+    end
+  end; alias save_what_into  save_file # === save_what_into
+       alias save_what_to    save_file # === save_what_to
+       alias save_what_where save_file # === save_what_where
+       alias write_what_into save_file # === write_what_into
+       alias write_what_to   save_file # === write_what_to
+       alias save_to         save_file # === save_to
+       alias save            save_file # === save
+       alias save_file       save_file # === save_file
+
+  # ========================================================================= #
+  # === SaveFile.append_what_into
+  # ========================================================================= #
+  def self.append_what_into(
+      what              = "Testing.\n",
+      into_where        = 'default.txt',
+      permission_to_use = ::SaveFile::DEFAULT_PERMISSION_TO_USE
+    )
+    ::SaveFile.save_what_into(
+      what,
+      into_where, 
+      permission_to_use,
+      'a+'
+    )
+  end; self.instance_eval { alias append_file append_what_into } # === SaveFile.append_file
+
+  extend self # Make SaveFile.save_file() available.
+
+end

data/lib/save_file/module.rb

@@ -0,0 +1,3 @@
+require 'save_file/append/append_what_into.rb' # Pull in the module.
+# We also need to ensure that append_what_into() works
+# as well when requiring that file.

data/lib/save_file/requires/requires.rb

@@ -0,0 +1,2 @@
+require 'save_file/append/append_what_into.rb'
+require 'save_file/base/base.rb'

data/lib/save_file/version/version.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module SaveFile
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.0.34'
+
+end

data/lib/save_file.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'save_file/requires/requires.rb'

data/save_file.gemspec

@@ -0,0 +1,89 @@
+# =========================================================================== #
+# Gemspec for Project SaveFile.
+# =========================================================================== #
+require 'save_file/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name     = 'save_file'
+  s.version  = SaveFile::VERSION
+  s.date     = Time.now.strftime('%Y-%m-%d')
+  
+  DESCRIPTION = <<-EOF
+
+This class can be used to save a file in a convenient way,
+by giving you a very simple save-file functionality.
+
+I liked the name 'save_file()' a lot, and I found that I
+was  needing such a functionality in many of my projects,
+so I made a tiny gem that would do exactly this. Note
+that the recommended methods are write_what_into() and
+append_what_into() - at the least for me, this is easy
+to remember.
+
+Of course you can use File.open() or File.new() already
+as-is in block variant, so there is no need to use a 
+gem like this one here - but I did not want to have to
+deal with file permissions or missing files or similar
+all on my own, via the File API that I do not as easily
+remember. So I just wrote an API that is simple enough
+for my use cases. 
+
+Usage examples:
+
+    require 'save_file'
+    save_what_into('test', '/tmp/test.txt')
+
+You can also use:
+
+    SaveFile.write_what_into(what, into)
+    SaveFile.append_what_into(what, into)
+
+The main module can be included into a class,
+which then will have these methods available.
+
+This project has no external dependencies, deliberately 
+so. It has to remain stand-alone.
+
+Version 1.0.3 made it more clear when to use save_file()
+and when to use append_into_file().
+  EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+  
+  s.extra_rdoc_files = %w()
+  
+  s.authors    = ['Robert A. Heiler']
+  s.email      = Roebe.email?
+  these_files  = Dir['**/*']
+  s.files      = these_files
+  s.files     << 'README.md'
+  s.license    = 'MIT'
+
+  # ========================================================================= #
+  # Show this when a user installs this project.
+  # ========================================================================= #
+  s.post_install_message = <<-EOF
+
+This gem, called "save_file", can be used to quickly save content
+into a file. This is easily possible in ruby with File.open {} 
+as-is, but I wanted to have this available as a toplevel-method
+on module SaveFile.s.required_ruby_version     = '>= '+Roebe.second_most_stable_version_of_ruby
+
+See the following usage example:
+
+  require 'save_file'
+
+  SaveFile.write_what_into("Hello world!", 'foobar.txt')
+
+  EOF
+
+  s.homepage = 'https://rubygems.org/gems/save_file'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+}

data/test/testing_save_file.rb

@@ -0,0 +1,32 @@
+# =========================================================================== #
+# Code to test the save_file functionality.
+# =========================================================================== #
+require 'colours/autoinclude'
+require 'save_file/autoinclude'
+N = "\n"
+save_into = '/Depot/Temp/OK'
+if File.exist? save_into
+  File.delete(save_into)
+end
+e 'We will test the functionality of the save_file gem next.'
+e 'We will save our test dataset into the '+
+  'directory: '+sdir(save_into)+N+N
+e '(1) First, we test the save_file() functionality:'
+e 'For this, we will save the string "yo" '+
+  'into `'+sfile(save_into)+'`.'
+save_file('yo', save_into)
+
+e
+e '(2) Second, we test the append_what_into() '+
+  'functionality:'
+e 'This will append the string "there" into '+
+  'the same file.'
+append_what_into(' there', save_into)
+append_what_into(' OMG!'+N+N+N+'CAN THIS REALLY BE?', 
+  save_into)
+e 'Done!'
+e
+e 'View the file at:'
+e
+e '  cat '+sfile(save_into)
+e

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: save_file
+version: !ruby/object:Gem::Version
+  version: 1.0.34
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-15 00:00:00.000000000 Z
+dependencies: []
+description: "\nThis class can be used to save a file in a convenient way,\nby giving
+  you a very simple save-file functionality.\n\nI liked the name 'save_file()' a lot,
+  and I found that I\nwas  needing such a functionality in many of my projects,\nso
+  I made a tiny gem that would do exactly this. Note\nthat the recommended methods
+  are write_what_into() and\nappend_what_into() - at the least for me, this is easy\nto
+  remember.\n\nOf course you can use File.open() or File.new() already\nas-is in block
+  variant, so there is no need to use a \ngem like this one here - but I did not want
+  to have to\ndeal with file permissions or missing files or similar\nall on my own,
+  via the File API that I do not as easily\nremember. So I just wrote an API that
+  is simple enough\nfor my use cases. \n\nUsage examples:\n\n    require 'save_file'\n
+  \   save_what_into('test', '/tmp/test.txt')\n\nYou can also use:\n\n    SaveFile.write_what_into(what,
+  into)\n    SaveFile.append_what_into(what, into)\n\nThe main module can be included
+  into a class,\nwhich then will have these methods available.\n\nThis project has
+  no external dependencies, deliberately \nso. It has to remain stand-alone.\n\nVersion
+  1.0.3 made it more clear when to use save_file()\nand when to use append_into_file().\n"
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/save_file.rb
+- lib/save_file/append/append_what_into.rb
+- lib/save_file/autoinclude.rb
+- lib/save_file/base/base.rb
+- lib/save_file/constants.rb
+- lib/save_file/module.rb
+- lib/save_file/module/save_file.rb
+- lib/save_file/requires/requires.rb
+- lib/save_file/version/version.rb
+- save_file.gemspec
+- test/testing_save_file.rb
+homepage: https://rubygems.org/gems/save_file
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\nThis gem, called \"save_file\", can be used to quickly save
+  content\ninto a file. This is easily possible in ruby with File.open {} \nas-is,
+  but I wanted to have this available as a toplevel-method\non module SaveFile.s.required_ruby_version
+  \    = '>= '+Roebe.second_most_stable_version_of_ruby\n\nSee the following usage
+  example:\n\n  require 'save_file'\n\n  SaveFile.write_what_into(\"Hello world!\",
+  'foobar.txt')\n\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.27
+requirements: []
+rubygems_version: 3.2.27
+signing_key:
+specification_version: 4
+summary: 'This class can be used to save a file in a convenient way, by giving you
+  a very simple save-file functionality.  I liked the name ''save_file()'' a lot,
+  and I found that I was  needing such a functionality in many of my projects, so
+  I made a tiny gem that would do exactly this. Note that the recommended methods
+  are write_what_into() and append_what_into() - at the least for me, this is easy
+  to remember.  Of course you can use File.open() or File.new() already as-is in block
+  variant, so there is no need to use a  gem like this one here - but I did not want
+  to have to deal with file permissions or missing files or similar all on my own,
+  via the File API that I do not as easily remember. So I just wrote an API that is
+  simple enough for my use cases.   Usage examples:  require ''save_file'' save_what_into(''test'',
+  ''/tmp/test.txt'')  You can also use:  SaveFile.write_what_into(what, into) SaveFile.append_what_into(what,
+  into)  The main module can be included into a class, which then will have these
+  methods available.  This project has no external dependencies, deliberately  so.
+  It has to remain stand-alone.  Version 1.0.3 made it more clear when to use save_file()
+  and when to use append_into_file().'
+test_files: []