duffy 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f500ee475e148d1e0f37aeaead04c15e0f280d03
-  data.tar.gz: a572c350b1398456699d20ce7eac3d39a4cdd667
+  metadata.gz: f8f76d6f0836c26f999f5354fb66878964f731c0
+  data.tar.gz: f4e5cd23c6bfcf19621e66beb391b873dd37fc3f
 SHA512:
-  metadata.gz: 1b1595e172f2769dfb763a91129997db94be1cd0687d151ceb83d1d66b52543884ec3c9a540e7480bee7b9a18f47f28fdd4b5a8e64ab9d1dd93ee981539446bd
-  data.tar.gz: be4334f85f1c7fcd3d1395de5acf818633d9b659c7262d1d7e32e0f4d532c71080c97c338d26d886026a3270ebeed93a2be93789252cbdae86217ab7641a8605
+  metadata.gz: ef4bcde07bca8d30a069bb6ec57d0f8cda82572ff5b4d61f11568ce2681faa03ab5c95d950a2f33bc18d34ec725ddc508c163bdde1759cf13f6179379b9b42ca
+  data.tar.gz: 6270daf98b3bf80d76a1a8078e70e2fb5bbd96c08049b55d596bc51d8343e3cfaf621376d23c109d40156c025d2dcaa2baec983e1210215f9747a9bdb5daebd1

data/.rubocop.yml

@@ -0,0 +1,38 @@
+# 80 characters, Ruby Style Guide?  Really?  This isn't DOS.                                                     120 -->
+Metrics/LineLength:
+  Max: 120
+
+# Ruby console always uses double quotes for results.  I'm supposed to find-and-replace all my results?  Nope.
+Style/StringLiterals:
+  Enabled: false
+
+# In general I agree with this but don't find it important enough to waste time on.
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+Style/EmptyLines:
+  Enabled: false
+
+# I don't think this needs to be strictly one way or the other.
+Style/EmptyMethod:
+  Enabled: false
+
+# Another one of those it's good enough for ruby irb, it's good enough for me:
+Style/WordArray:
+  Enabled: false
+
+# These are going to be ginormous, don't worry about it.
+Metrics/BlockLength:
+  ExcludedMethods:
+  - describe
+  - context
+
+# I've literally never seen anyone use %i for this, and it looks terrible.
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Nobody does this and it looks stupid
+Style/NumericLiterals:
+  Enabled: false
+
+Style/CaseIndentation:
+  Enabled: false

data/README.md

@@ -62,7 +62,6 @@ habtm             | has_and_belongs_to_many
 
 
 ## Git Access:
-This one is namespaced in case you use the 'git' gem.  I found it to be overkill for what I wanted.
 
 Method    |   Result
 ----------|---------
@@ -73,8 +72,8 @@ Duffy::Git.branch   | Current git branch.
 
 
 ## CPU Detection:
-Linux and Mac only for now, each method returns 1 on unsupported hosts.
-Example results for my dual core i5 with hyperthreading.
+* Linux and Mac only for now, each method returns 1 on unsupported hosts.
+* Example results for my dual core i5 with hyperthreading.
 
 Method    |   Result
 ----------|---------
@@ -84,6 +83,16 @@ Duffy::System.threads    | 4
 Duffy::System.sane_load  | 3
 Duffy::System.cpu_percent| 16%
 
+## Memory Statistics:
+* All values returned in Megabytes.
+* Available + Used always exactly adds up to Total.
+
+Method    |   Result
+----------|---------
+Duffy::System.mem_total       | 4096
+Duffy::System.mem_available   | 3072
+Duffy::System.mem_used        | 1024
+
 
 ## View Helpers:
 

data/duffy.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport' # Required for ActiveSupport::Configurable
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rails", '>= 5.0'
   spec.add_development_dependency "rspec"
 end

data/lib/duffy/duffy_helper.rb

@@ -4,37 +4,8 @@ module DuffyHelper
   # It's just an <li> with a link inside it.
   # menu_tag('Help', help_path)   =>  <li><a href="/help">Help</a></li>
   def menu_tag(title, link, options = {})
-    content_tag(:li, link_to(title, link), options)
-  end
-
-  # Create Excel icon in consistent location
-  # This is intended to display the xlsx version of a view.
-  # Add a yield(:excel) somewhere in your application layout:
-  #   content_tag( :li, yield(:excel), class: :excel) if content_for?(:excel)
-  def excel_icon(link = params.merge(format: "xlsx"))
     ActiveSupport::Deprecation.warn('This method will be removed without replacement in future versions')
-    content_for :excel do
-      link_to(image_tag('excel.png'), link)
-    end
-  end
-
-  # Create a simple link with the class "icon"
-  # Generate a uniq and reasonable id based on the link passed (if any)
-  # Add any classes passed in via options
-  # Add the "favorite" class if icon is favorited
-  #  - This is application specific and will just not do anything if it runs into a problem
-  # If any uncaught exceptions are thrown in production you'll just get nothing, otherwise you'll get the error on screen.
-  def icon(title, link, options = {})
-    ActiveSupport::Deprecation.warn('This method will be removed without replacement in future versions')
-    begin
-      options[:id]    = "icon_#{link.parameterize("_")}" unless link.blank?
-      options[:class] = [:icon] << options[:class]
-      options[:class] << :favorite if defined?(current_user) and (current_user.person.details.where(key: "favorite_#{options[:id]}").any? rescue false)
-      options[:class] = options[:class].flatten.compact
-      link_to(title, link, options)
-    rescue Exception => e
-      Rails.env.development? ? content_tag(:p, e) : nil
-    end
+    content_tag(:li, link_to(title, link), options)
   end
 
 end

data/lib/duffy/git.rb

@@ -1,38 +1,42 @@
 require 'active_support/core_ext/object/blank'
 
 module Duffy
-
   # I like to have a git log in the admin section of my websites.  I use these in my capistrano tasks to
   # generate what I need and upload along with the deployment.
   # If for some reason you don't have git installed, each method returns nil.
-
   class Git
     class << self
-
       # Produce tab separated listing of current git log.
       # Useful for displaying a development history page.
       def log
-        `git log --pretty=format:"%ad%x09%an%x09%s" --date=short`.strip.presence rescue nil
+        `git log --pretty=format:"%ad%x09%an%x09%s" --date=short`.strip.presence
+      rescue
+        nil
       end
 
       # I tend use the commit count / 1000.0 as a version for my applications.
       # You wouldn't want to do that if you're building a gem used by others.
       def count
-        `git rev-list HEAD --count`.presence.to_i rescue nil
+        `git rev-list HEAD --count`.presence.to_i
+      rescue
+        nil
       end
 
       # Read the git committer's email.
       # Uses local if present, otherwise global (git default procedure)
       # nil if unset
       def email
-        `git config --get user.email`.strip.presence rescue nil
+        `git config --get user.email`.strip.presence
+      rescue
+        nil
       end
 
       # Display the current branch
       def branch
-        `git rev-parse --abbrev-ref HEAD`.strip.presence rescue nil
+        `git rev-parse --abbrev-ref HEAD`.strip.presence
+      rescue
+        nil
       end
-
     end
   end
 end

data/lib/duffy/railtie.rb

@@ -4,13 +4,14 @@ require File.dirname(__FILE__) + "/duffy_helper"
 require File.dirname(__FILE__) + "/beast_mode_helper"
 
 module Duffy
+  # Make our helpers available to those host application
   class Railtie < Rails::Railtie
     initializer "duffy_helper" do
-      ActiveSupport.on_load( :action_view ){ include DuffyHelper }
+      ActiveSupport.on_load(:action_view) { include DuffyHelper }
     end
 
     initializer "beast_mode_helper" do
-      ActiveSupport.on_load( :action_view ){ include BeastModeHelper }
+      ActiveSupport.on_load(:action_view) { include BeastModeHelper }
     end
   end
-end
+end

data/lib/duffy/system.rb

@@ -1,22 +1,19 @@
 module Duffy
-
   # Depending on your hardware, you may want to make decisions in your code.
   # I use this to figure out how many processes I can launch in parallel.
-
-  # This is linux specific (for now) and will return 1 for everything on other systems.
-
   class System
     class << self
-
       # How many Physical CPUs do you have.
       # Linux:  Detected by counting unique physical IDs
       # Mac:    hw.packages
       def cpus
         case RUBY_PLATFORM
-          when /linux/  then File.read('/proc/cpuinfo').scan(/^physical id.*/).uniq.count rescue 1
-          when /darwin/ then `sysctl -n hw.packages`.to_i rescue 1
+          when /linux/  then File.read('/proc/cpuinfo').scan(/^physical id.*/).uniq.count
+          when /darwin/ then `sysctl -n hw.packages`.to_i
           else 1
         end
+      rescue
+        1
       end
 
       # How many actual CPU cores do we have not including Hyperthreading
@@ -24,19 +21,23 @@ module Duffy
       # Mac:    hw.physicalcpu
       def cores
         case RUBY_PLATFORM
-          when /linux/  then (File.read('/proc/cpuinfo').scan(/^cpu cores.*/).first.scan(/\d+$/).first.to_i rescue 1) * cpus
-          when /darwin/ then `sysctl -n hw.physicalcpu`.to_i rescue 1
+          when /linux/  then File.read('/proc/cpuinfo').scan(/(cpu cores).*(\d+)/)[0][1].to_i * cpus
+          when /darwin/ then `sysctl -n hw.physicalcpu`.to_i
           else 1
         end
+      rescue
+        1
       end
 
       # How many threads does the system have.
       def threads
         case RUBY_PLATFORM
-          when /linux/  then File.read('/proc/cpuinfo').scan(/^processor\s*:/).size rescue 1
-          when /darwin/ then `sysctl -n hw.ncpu`.to_i rescue 1
+          when /linux/  then File.read('/proc/cpuinfo').scan(/^processor\s*:/).size
+          when /darwin/ then `sysctl -n hw.ncpu`.to_i
           else 1
         end
+      rescue
+        1
       end
 
       # What is a sane number of threads to use for data processing.
@@ -46,23 +47,57 @@ module Duffy
       end
 
       # The system's current CPU utilization.
-      # Darwin: Get a list of all processes' CPU percentage and add them up.  Accurate to a couple percent vs. Activity Monitor.
+      # Darwin: Get a list of all processes' CPU percentage and add them up.
       # Linux:  Read /proc/stat twice and take the difference to give cpu time used in that interval.
       def cpu_percent
         case RUBY_PLATFORM
-          when /darwin/ then (`ps -A -o %cpu`.lines.map(&:to_f).inject(:+) rescue 0) / threads
-          when /linux/  then proc_diff rescue 0
+          when /darwin/ then `ps -A -o %cpu`.lines.map(&:to_f).inject(:+) / threads
+          when /linux/  then proc_diff
+          else 0
+        end
+      rescue
+        0
+      end
+
+      # Total system memory in Megabytes
+      # Darwin: hw.memsize (bytes)
+      # Linux:  Read /proc/meminfo
+      def mem_total
+        case RUBY_PLATFORM
+          when /darwin/ then `sysctl -n hw.memsize`.to_i / 1024 / 1024
+          when /linux/  then File.read("/proc/meminfo").scan(/MemTotal:\s*(\d+)/)[0][0].to_i / 1024
+          else 0
+        end
+      rescue
+        0
+      end
+
+      # Memory available for use in Megabytes
+      # Darwin: vm_stat (Pages Free + Pages Inactive)
+      # Linux:  Read /proc/meminfo
+      def mem_available
+        case RUBY_PLATFORM
+          when /darwin/ then `vm_stat`.lines.grep(/(free:|inactive:)\s*(\d+)/){$2}.map(&:to_i).inject(:+) * 4 / 1024
+          when /linux/  then (File.read("/proc/meminfo").lines.grep(/MemAvailable/).first.split[1].to_i / 1024)
           else 0
         end
+      rescue
+        0
       end
 
+      # Memory used
+      # Subtract mem_available from mem_total.
+      # This ignores file cache etc that is not actually used by programs.
+      def mem_used
+        mem_total - mem_available
+      end
 
       private
 
       # [CPU USE, CPU IDLE]
       def proc_stat
         cpu = File.open("/proc/stat", "r").read.lines.first
-        [cpu.split[1 .. 3].map(&:to_i).inject(:+), cpu.split[1 .. 4].map(&:to_i).inject(:+)]
+        [cpu.split[1..3].map(&:to_i).inject(:+), cpu.split[1..4].map(&:to_i).inject(:+)]
       end
 
       # Poll proc_stat twice and find the usage in that time.
@@ -73,7 +108,6 @@ module Duffy
         f = proc_stat
         (f[0] - s[0]) * 100.0 / (f[1] - s[1])
       end
-
     end
   end
 end

data/lib/duffy/version.rb

@@ -1,8 +1,9 @@
 module Duffy
-  VERSION = "0.2.7"
+  VERSION = "0.3.0"
 end
 
 # History
+# 0.3.0 - Added system memory methods.  Removed deprecated icon methods.
 # 0.2.7 - Deprecated "icon" and "excel_icon"
 # 0.2.6 - Added cpu_percent to give the current total CPU usage percentage.
 # 0.2.5 - Added beast_mode helper to render partials in parallel

data/lib/duffy.rb

@@ -24,7 +24,6 @@ require File.dirname(__FILE__) + "/duffy/version"
 # [application.css]
 # *= require duffy/reset
 module Duffy
-
   def self.configuration
     @configuration ||= Duffy::Configuration.new
   end
@@ -56,8 +55,4 @@ module Duffy
     config_accessor(:fiscal_month)      {7}
     config_accessor(:fiscal_day)        {1}
   end
-
 end
-
-
-

data/spec/date_spec.rb

@@ -4,23 +4,22 @@ describe Date do
   describe "fiscal_year (Assuming July 1st Start)" do
 
     it "2000-07-01 => 2001" do
-      expect(Date.new(2000,7,1).fiscal_year).to eq(2001)
+      expect(Date.new(2000, 7, 1).fiscal_year).to eq(2001)
     end
 
     it "2000-06-30 => 2000" do
-      expect(Date.new(2000,6,30).fiscal_year).to eq(2000)
+      expect(Date.new(2000, 6, 30).fiscal_year).to eq(2000)
     end
 
     it "2000-01-01 => 2000" do
-      expect(Date.new(2000,1,1).fiscal_year).to eq(2000)
+      expect(Date.new(2000, 1, 1).fiscal_year).to eq(2000)
     end
 
     it "1999-12-31 => 2000" do
-      expect(Date.new(1999,12,31).fiscal_year).to eq(2000)
+      expect(Date.new(1999, 12, 31).fiscal_year).to eq(2000)
     end
 
   end
 
 
 end
-

data/spec/string_spec.rb

@@ -79,4 +79,4 @@ describe String do
 
 
 
-end
+end

data/spec/system_spec.rb

@@ -1,23 +1,28 @@
 require 'spec_helper'
 describe Duffy::System do
 
-  # These methods return per-host settings, so all I can think of to test is that they return integers.
+  # These methods return per-host settings.  Verify the return object type and value within reason.
   # This generates the documentation more than anything.
   describe "cpus" do
     it "returns the number of physical cpus" do
       expect(Duffy::System.cpus).to be_an(Integer)
+      expect(Duffy::System.cpus).to be >= 1
     end
   end
 
   describe "cores" do
     it "returns the total number of CPU cores" do
       expect(Duffy::System.cores).to be_an(Integer)
+      expect(Duffy::System.cores).to be >= 1
+
     end
   end
 
   describe "threads" do
     it "returns the total number of threads" do
       expect(Duffy::System.threads).to be_an(Integer)
+      expect(Duffy::System.threads).to be >= 1
+
     end
   end
 
@@ -27,8 +32,26 @@ describe Duffy::System do
     end
   end
 
+  describe 'mem_total' do
+    it "returns the total amount of physical memory in Megabytes" do
+      expect(Duffy::System.mem_total).to be_an(Integer)
+      expect(Duffy::System.mem_total).to be > 0
+    end
+  end
 
+  describe 'mem_available' do
+    it "returns the amount of available memory in Megabytes" do
+      expect(Duffy::System.mem_available).to be_an(Integer)
+      expect(Duffy::System.mem_available).to be > 0
+    end
+  end
 
+  describe 'mem_used' do
+    it "returns the amount of used memory in Megabytes" do
+      expect(Duffy::System.mem_used).to be_an(Integer)
+      expect(Duffy::System.mem_used).to be > 0
+    end
+  end
 
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duffy
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Jacob Duffy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Library of things