arbitrium 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6eb17eeec355a479c42cc6163894e9cbcbe18e1
-  data.tar.gz: 8f6d89419ef27bc67f729dd187a02cac9b2e603c
+  metadata.gz: 07f0370650dc517751f82305b914467deff9dd8b
+  data.tar.gz: 0c5b7f18c64daac63bea6b4f9e9290d4232883b2
 SHA512:
-  metadata.gz: 4d5f50cf476ae0ca6a29050de60e0eebb77e785de092007fb8b61d69c661dae88307c1340f83fbb7d346b7e5e010a4428cbb04a91366fdde4ac79776891714a2
-  data.tar.gz: 35617595350d81bd11b1ca0ed2bcb9e6d5627dac253a5929038e4e57d44bbf0288a24278980fe66ee61f0793bb83dbd51c469e43390cb5465d0c38af60c9e1f6
+  metadata.gz: faaba03ff8431e0cac29ee717b6a14ba8fe2fc8cc1ea6fe86b599f422ad737f6bef758915f6528427f9cf4e1526ee1469cfefa0529d7e19e3728bcddb53558f7
+  data.tar.gz: 3c1f2352b07960d6276485faecca4cc43f7c4005a9d330adcef3a5ff7f2c62aa3b7fd9863a7b627985a721497b8d748b4b40249b294d42e1c5b3848021e308c7

data/README.md

@@ -19,14 +19,62 @@ Or install it yourself as:
     $ gem install arbitrium
 
 ## Usage
+#### There are two different uses for this gem.
+##### Command Line File/Class Creator
 
-To use this gem simply call Arbitrium::Result.new and pass in a boolean whether the build failed or not, a corresponding message, and then the optional object.
+Once you have the gem installed type `bundle exec arbitrium -h` to see the different options.
 
-## Development
+Example Usage:
+```
+bundle exec arbitrium -f place/where/I/want/file.rb -m run -a Fake,Name
+# Results in the following file being created: [link.to.file]
+bundle exec arbitrium -f place/where/I/want/file.rb
+# Results in the following file being created: [link.to.file]
+```
+
+When using the command line generator make sure that you are always using the path from your current position in the file structure.
+
+##### Using Arbitrium::Result
+In your method that they want to have the Result object call `Arbitrium::Result.new()` and pass in your arguments.  
+
+Important things to note:
+  1. You must pass at least two arguments
+  2. The first argument must be a boolean type
+  3. The second argument must be a string type
+Any deviation from data types will result in an error being raised.
+
+What a successful result may look like:
+```
+result = Arbitrium::Result.new(user.save, user.errors.messages.join(', '), user)
+
+result.successful? # true
+result.failed?     # false
+result.message     # ''
+result.object      # User object
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# You can also call the class method default_success which takes an optional object
+result = Arbitrium::Result.default_success(OptionalObject)
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+result.successful? # true
+result.message     # 'Completed Succesfully.'
+result.object      # OptionalObject
+```
+
+What a failed result may look like:
+```
+result = Arbitrium::Result.new(false, 'Failed to successfully do my job')
+
+result.successful? # false
+result.message     # Failed to successfully do my job
+result.object      # nil
+
+# You can also call the class method default_failure which takes an optional object
+result = Arbitrium::Result.default_success
+
+result.failed?  # true
+result.message  # 'Failed to complete.'
+result.object   # nil
+```
 
 ## Contributing
 

data/arbitrium.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   << 'arbitrium'
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.14"

data/bin/arbitrium

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require_relative '../lib/arbitrium'
+require_relative '../lib/arbitrium/file_creator'
+require 'optparse'
+
+options = { pwd: Dir.pwd, file: nil, method_name: 'perform', module_array: [] }
+
+parser =
+  OptionParser.new do |opts|
+    opts.banner = "Usage: arbitrium [options]"
+    opts.on('-fMANDATORY', '--file=MANDATORY', 'File with path from current directory') { |file| options[:file] = file }
+    opts.on('-m', '--method=OPTIONAL', 'Name of actionable method') { |method| options[:method_name] = method }
+    opts.on('-a', '--module_array=OPTIONAL', 'Modules that the class is nested under seperated by a comma') { |module_array| options[:module_array] = module_array.split(',').map(&:strip) }
+    opts.on('-h', '--help') { puts opts; exit }
+  end
+
+args = parser.order!(ARGV) {}
+parser.parse!(args)
+
+Arbitrium::FileCreator.perform(options)

data/bin/console

@@ -3,12 +3,5 @@
 require "bundler/setup"
 require "arbitrium"
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require "irb"
 IRB.start(__FILE__)

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/arbitrium.rb

@@ -1,4 +1,7 @@
-Dir[File.dirname(__FILE__) + '/lib/*.rb'].each { |file| require file }
+require_relative 'arbitrium/result'
+require_relative 'arbitrium/version'
+require_relative 'arbitrium/file_creator'
+
 
 module Arbitrium
 end

data/lib/arbitrium/file_creator.rb

@@ -0,0 +1,92 @@
+module Arbitrium
+  class FileCreator
+    attr_reader :file_with_path, :method_name, :pwd, :module_array
+
+    def self.perform(options)
+      new(options).perform
+    end
+
+    options = { pwd: Dir.pwd, file: nil, method_name: 'perform', module_array: [] }
+
+
+    def initialize(options)
+      puts options
+      @file_with_path = options[:file]
+      @method_name    = options[:method_name]
+      @pwd            = options[:pwd]
+      @module_array   = options[:module_array]
+    end
+
+    def perform
+      puts module_array
+      puts create_file ? "Successfully created file in #{full_path_with_file}" : "Failed to create file!"
+    end
+
+    private
+
+    def create_file
+      File.open(full_path_with_file, 'w') do |file|
+        file.write(<<~EOF
+          #{file_header}
+          #{add_spaces}  def self.#{method_name}()
+          #{add_spaces}    new().#{method_name}
+          #{add_spaces}  end
+
+          #{add_spaces}  def initialize()
+          #{add_spaces}    # insert instance variables here
+          #{add_spaces}  end
+
+          #{add_spaces}  def #{method_name}
+          #{add_spaces}    # define tasks needed to complete here
+          #{add_spaces}    # next, define result of tasks
+          #{add_spaces}    Arbitrium::Result.new()
+          #{add_spaces}  end
+
+          #{add_spaces}  private
+          #{add_spaces}  # define methods from perform here
+          #{file_footer}
+          end
+        EOF
+        )
+      end
+    end
+
+    def full_path_with_file
+      pwd + modified_file_with_path
+    end
+
+    def modified_file_with_path
+      return if file_with_path[0] == '/'
+
+      '/' + file_with_path
+    end
+
+    def file_header
+      "#{module_header}\n#{class_header}"
+    end
+
+    def module_header
+      module_array.map.with_index { |module_name, i| "#{add_spaces(i)}module #{module_name}" }.join("\n")
+    end
+
+    def class_header
+      module_array.empty? ? "class #{class_name}" : "\n#{add_spaces(module_array.length)} class #{class_name}"
+    end
+
+    def add_spaces(value = module_array.length)
+      '  ' * value
+    end
+
+    def class_name
+      class_portion_of_path.split('_').map(&:capitalize).join('')
+    end
+
+    def class_portion_of_path
+      file_with_path[0...file_with_path.length-3].match(/([^\/]+)$/)[0]
+    end
+
+    def file_footer
+      module_array.map.with_index { |_, i| puts i; "#{add_spaces((module_array.length - i))}end" }.join("\n")
+    end
+  end
+end

data/lib/arbitrium/result.rb

@@ -6,18 +6,42 @@ module Arbitrium
       new(true, 'Completed successfully.', object)
     end
 
+    def self.default_failure(object = nil)
+      new(false, 'Failed to complete.', object)
+    end
+
     def initialize(success, message, object = nil)
       @success = success
       @message = message
       @object  = object
+
+      raise 'Error! Incorrect data types for arguments expected (boolean, string, object)!' unless valid?
     end
 
-    def success?
+    def successful?
       self.success
     end
 
-    def failure?
-      !success?
+    def failed?
+      !successful?
+    end
+
+    def valid?
+      check_validity
+    end
+
+    private
+
+    def check_validity
+      check_success_class && check_message_class
+    end
+
+    def check_success_class
+      success.is_a?(TrueClass) || success.is_a?(FalseClass)
+    end
+
+    def check_message_class
+      message.is_a?(String)
     end
   end
 end

data/lib/arbitrium/version.rb

@@ -1,3 +1,3 @@
 module Arbitrium
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arbitrium
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Lollar
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,7 +58,8 @@ description: This gem was inspired by the overabundance of logic that I continua
   in scope and will be modeled after the way that I like to write service object classes.
 email:
 - lollar.mchl@gmail.com
-executables: []
+executables:
+- arbitrium
 extensions: []
 extra_rdoc_files: []
 files:
@@ -69,9 +70,11 @@ files:
 - README.md
 - Rakefile
 - arbitrium.gemspec
+- bin/arbitrium
 - bin/console
 - bin/setup
 - lib/arbitrium.rb
+- lib/arbitrium/file_creator.rb
 - lib/arbitrium/result.rb
 - lib/arbitrium/version.rb
 homepage: https://github.com/lollar/arbitrium