battman 0.0.1

data/spec/lib/battman/smapi_battery_spec.rb

@@ -0,0 +1,173 @@
+require 'battman/smapi_battery'
+
+module Battman
+
+  describe SmapiBattery do
+
+    it 'is a subclass of Battery' do
+      expect(SmapiBattery.new).to be_a Battery
+    end
+
+    describe '#path' do
+
+      let(:path_prefix) { '/sys/devices/platform/smapi' }
+
+      it 'builds the path for a smapi battery with the correct index' do
+        battery = SmapiBattery.new
+
+        expect(battery.path).to eq File.join(path_prefix, 'BAT0')
+
+        battery = SmapiBattery.new(1)
+
+        expect(battery.path).to eq File.join(path_prefix, 'BAT1')
+      end
+
+      it 'sets the corresponding instance variable' do
+        battery = SmapiBattery.new
+        path = battery.path
+
+        expect(battery.instance_variable_get(:@path)).to eq path
+      end
+    end
+
+    let(:battery) { SmapiBattery.new }
+
+    before(:each) do
+      allow(File).to receive(:join).and_call_original
+    end
+
+    describe '#remaining_percent' do
+
+      let(:percent_file) { File.join(battery.path, 'remaining_percent') }
+
+      before(:each) do
+        allow(File).to receive(:read).with(percent_file).and_return("100\n")
+      end
+
+      it 'reads the value from the correct file' do
+        battery.remaining_percent
+
+        expect(File).to have_received(:read).with(percent_file)
+      end
+
+      it 'returns the integer value of the read file contents' do
+        expect(battery.remaining_percent).to eq 100
+      end
+
+    end
+
+    describe '#remaining_running_time' do
+      let(:running_time_file) { File.join(battery.path, 'remaining_running_time') }
+
+      it 'reads the value from the correct file' do
+        allow(File).to receive(:read).with(running_time_file).and_return("100\n")
+        battery.remaining_running_time
+
+        expect(File).to have_received(:read).with(running_time_file)
+      end
+
+      it 'returns the number of seconds remaining' do
+        allow(File).to receive(:read).with(running_time_file).and_return("100\n")
+
+        expect(battery.remaining_running_time).to eq 6000
+      end
+
+      it 'raises a WrongStateError if the battery is not discharging' do
+        allow(File).to receive(:read).with(running_time_file).and_return("not_discharging\n")
+
+        expect { battery.remaining_running_time }.to raise_error(WrongStateError)
+      end
+
+    end
+
+    describe '#remaining_charging_time' do
+      let(:charging_time_file) { File.join(battery.path, 'remaining_charging_time') }
+
+      it 'reads the value from the correct file' do
+        allow(File).to receive(:read).with(charging_time_file).and_return("100\n")
+        battery.remaining_charging_time
+
+        expect(File).to have_received(:read).with(charging_time_file)
+      end
+
+      it 'returns the number of seconds remaining' do
+        allow(File).to receive(:read).with(charging_time_file).and_return("100\n")
+
+        expect(battery.remaining_charging_time).to eq 6000
+      end
+
+      it 'raises a WrongStateError if the battery is not charging' do
+        allow(File).to receive(:read).with(charging_time_file).and_return("not_charging\n")
+
+        expect { battery.remaining_charging_time }.to raise_error(WrongStateError)
+      end
+    end
+
+    describe '#power' do
+      let(:power_file) { File.join(battery.path, 'power_avg') }
+
+      it 'reads the value from the correct file' do
+        allow(File).to receive(:read).with(power_file).and_return("1000\n")
+        battery.power
+
+        expect(File).to have_received(:read).with(power_file)
+      end
+
+      it 'returns the power used in watt' do
+        allow(File).to receive(:read).with(power_file).and_return("-1000\n")
+
+        expect(battery.power).to eq(-1.0)
+      end
+
+    end
+
+    describe "#state" do
+      let(:state_file) { File.join(battery.path, 'state') }
+
+      it 'reads the state from the correct file' do
+        allow(File).to receive(:read).with(state_file).and_return("discharging\n")
+        battery.state
+
+        expect(File).to have_received(:read).with(state_file)
+      end
+
+      it 'returns the correct state as a symbol' do
+        allow(File).to receive(:read).with(state_file).and_return("discharging\n")
+
+        expect(battery.state).to eq :discharging
+      end
+    end
+
+    describe "#remaining_energy" do
+      let(:energy_file) { File.join(battery.path, 'remaining_capacity') }
+
+      it 'reads the value from the correct file' do
+        allow(File).to receive(:read).with(energy_file).and_return("100000\n")
+        battery.remaining_energy
+
+        expect(File).to have_received(:read).with(energy_file)
+      end
+
+      it 'returns the remaining energy in Wh' do
+        allow(File).to receive(:read).with(energy_file).and_return("100000\n")
+        expect(battery.remaining_energy).to eq 100.0
+      end
+    end
+
+    describe "#full_energy" do
+      let(:energy_file) { File.join(battery.path, 'last_full_capacity') }
+
+      it 'reads the value from the correct file' do
+        allow(File).to receive(:read).with(energy_file).and_return("100000\n")
+        battery.full_energy
+
+        expect(File).to have_received(:read).with(energy_file)
+      end
+
+      it 'returns the remaining energy in Wh' do
+        allow(File).to receive(:read).with(energy_file).and_return("100000\n")
+        expect(battery.full_energy).to eq 100.0
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'simplecov'
+SimpleCov.start
+
+$: << '../lib'
+
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: battman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joakim Reinert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+description: Battman allows specifying actions to perform depending on the value of
+  some battery attribute
+email:
+- mail@jreinert.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- battman.gemspec
+- battman_example.rb
+- lib/battman.rb
+- lib/battman/acpi_battery.rb
+- lib/battman/battery.rb
+- lib/battman/dsl.rb
+- lib/battman/dsl/every_block.rb
+- lib/battman/dsl/watch_block.rb
+- lib/battman/errors.rb
+- lib/battman/smapi_battery.rb
+- lib/battman/version.rb
+- spec/lib/battman/acpi_battery_spec.rb
+- spec/lib/battman/battery_spec.rb
+- spec/lib/battman/dsl/every_block_spec.rb
+- spec/lib/battman/dsl/watch_block_spec.rb
+- spec/lib/battman/dsl_spec.rb
+- spec/lib/battman/smapi_battery_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jreinert/battman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple dsl for polling battery info
+test_files:
+- spec/lib/battman/acpi_battery_spec.rb
+- spec/lib/battman/battery_spec.rb
+- spec/lib/battman/dsl/every_block_spec.rb
+- spec/lib/battman/dsl/watch_block_spec.rb
+- spec/lib/battman/dsl_spec.rb
+- spec/lib/battman/smapi_battery_spec.rb
+- spec/spec_helper.rb
+has_rdoc: