volumerb 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTlmMDE4YjVlYTAxNTc2Y2ExYzFlNWY5MzBlNGJjYjU1ZDlhYmE5NQ==
-  data.tar.gz: !binary |-
-    ZmM2Nzg1ODgxYWI4ZWEwOWM5Nzk0MDBmOWYxYTE5MGI3YTI1YzQ5Mw==
+SHA1:
+  metadata.gz: 291e26073ab2bc2d6b31a36a411feacabfbfff74
+  data.tar.gz: b7b766aa186f874ad8f99a428bc937bc83ca0c6e
 SHA512:
-  metadata.gz: !binary |-
-    YjY1MWU1NGM0NWNjYTdjOTNhZmU2ZjViOTFiMmU1ZjkxODU1YjNiNjk4MmY1
-    NDY5ODU2NjlhMjkyOWUyYWMzZTA2OGEzMDIwMDJiNTY2NjY5ZDhmNzRjYWI0
-    ZGViMTZmYWQzOTg4MjE1M2MwNWU0M2YwOWY4YmIxMGI4M2I1ODk=
-  data.tar.gz: !binary |-
-    NTdhMzBjZmVlMGJhM2Y4ZDk1NWQ0M2RjYjc4YTMyOWQzODllZDYzMWE3MjJh
-    YjExNTJmNzNmYjZkYjM1ZmQ5ZGQ5NWQwNmNhODRhOWY5MTAzZjNjYTUwMDAz
-    NzYxZjAyMWY1YjZjNzk2MjlkZjcyNmMyOTJiNDU5YTJjNjUwZWI=
+  metadata.gz: 0b5fba40dcb77099474d1645e7bc406152dc04cb7e7bd74c75a9a17afde4ccd5c23eb329d5588334ce8a6f5001af88d3b6839fac5400bb369074133af1d4f1d3
+  data.tar.gz: ba429655b162266ed9c6cc5d6e79320fa5ce2cb83981943f9a54c285f398c51dab99192c9614dccbebdc6329584ef204be6698b3f7272df51a968c530838f11b

data/README.md

@@ -1,4 +1,4 @@
-# Volumerb
+# Volumerb 🔊
 
 Gem to manage the volume on GNU/Linux and Mac OS X operating systems.
 
@@ -19,15 +19,36 @@ Or install it yourself as:
 ## Usage
 
 The available methods are:
- * `vol`  - Returns the current volume state (on/off if unmuted/muted
+ * `vol`   - Returns the current volume state (on/off if unmuted/muted
    and a value)
- * `up`   - Increases volume.
- * `down` - Decreases volume.
- * `mute` - Mutes/unmutes sound., `vol` and `mute`.
- 
+ * `up`    - Increases volume.
+ * `down`  - Decreases volume.
+ * `mute`  - Mutes/unmutes.
+ * `value` - Sets/gets the volume value
+ * `state` - Returns the volume state (muted/unmuted)
+
 Example:
 
 ```ruby
+$ irb
+2.1.2 :001 > require 'volumerb'
+ => true
+2.1.2 :002 > Volumerb.vol
+ => {:value=>100, :state=>"on"}
+2.1.2 :003 > 10.times { Volumerb.down }
+ => 10
+2.1.2 :004 > Volumerb.value
+ => 70
+2.1.2 :005 > Volumerb.mute
+ => {:value=>70, :state=>"off"}
+2.1.2 :006 > Volumerb.mute
+ => {:value=>70, :state=>"on"}
+2.1.2 :007 > Volumerb.state
+ => "on"
+2.1.2 :008 > Volumerb.value = 30
+ => 30
+2.1.2 :009 > Volumerb.value = 100
+ => 100
 ```
 
 ## Contributing
@@ -39,5 +60,4 @@ Example:
 5. Create new Pull Request
 
 ## TODO
-* Method for setting the volume value directly, eg: Volumerb.vol = 30
-* Customize volume increase/decrease
+* Customize volume increase/decrease percentage

data/lib/volumerb.rb

@@ -2,37 +2,47 @@
 require 'volumerb/version'
 
 module Volumerb
-  def self.up
-    mixer unless @mixer
-    @mixer.up
+  def self.up(value = 3)
+    mixer.up(value)
   end
 
-  def self.down
-    mixer unless @mixer
-    @mixer.down
+  def self.down(value = 3)
+    mixer.down(value)
   end
 
   def self.mute
-    mixer unless @mixer
-    @mixer.mute
+    mixer.mute
   end
 
   def self.vol
-    mixer unless @mixer
-    @mixer.vol
+    mixer.vol
+  end
+
+  def self.state
+    mixer.vol[:state]
+  end
+
+  def self.value
+    mixer.vol[:value]
+  end
+
+  def self.value=(value)
+    mixer.value = value
   end
 
   private
 
   def self.mixer
-    if RUBY_PLATFORM =~ /linux/
-      require 'volumerb/linux_volume'
-      @mixer = Volumerb::LinuxVolume
-    elsif RUBY_PLATFORM =~ /darwin|macos/
-      require 'volumerb/mac_volume'
-      @mixer = Volumerb::MacVolume
-    else
-      raise "Unsupported Ruby platform"
+    @mixer ||= begin
+      if RUBY_PLATFORM =~ /linux/
+        require 'volumerb/linux_volume'
+        Volumerb::LinuxVolume
+      elsif RUBY_PLATFORM =~ /darwin|macos/
+        require 'volumerb/mac_volume'
+        Volumerb::MacVolume
+      else
+        raise "Unsupported Ruby platform"
+      end
     end
   end
 end

data/lib/volumerb/linux_volume.rb

@@ -1,13 +1,13 @@
 # -*- coding: utf-8 -*-
 module Volumerb
   module LinuxVolume
-    def self.up
-      `amixer -q sset Master 3%+`
+    def self.up(value = 3)
+      `amixer -q sset Master #{value}%+`
       vol
     end
 
-    def self.down
-      `amixer -q sset Master 3%-`
+    def self.down(value = 3)
+      `amixer -q sset Master #{value}%-`
       vol
     end
 
@@ -16,6 +16,11 @@ module Volumerb
       vol
     end
 
+    def self.value=(value)
+      `amixer set Master #{value}%`
+      vol
+    end
+
     def self.vol
       vol = `amixer get Master | grep "\[[0-9]*%\]\ \[o[n|f]"`
       number = vol.match(/([0-9]+)%/)[1]

data/lib/volumerb/mac_volume.rb

@@ -1,15 +1,15 @@
 # -*- coding: utf-8 -*-
 module Volumerb
   module MacVolume
-    def self.up
+    def self.up(value = 3)
       osa 'set currentVolume to output volume of (get volume settings)
-           set volume output volume (currentVolume + 3)'
+           set volume output volume (currentVolume + #{value})'
       vol
     end
 
-    def self.down
+    def self.down(value = 3)
       osa 'set currentVolume to output volume of (get volume settings)
-           set volume output volume (currentVolume - 3)'
+           set volume output volume (currentVolume - #{value})'
       vol
     end
 
@@ -20,6 +20,11 @@ module Volumerb
       vol
     end
 
+    def self.value=(value)
+      osa 'set volume output volume (#{value})'
+      vol
+    end
+
     def self.vol
       # Mac OS X output:
       # output volume:100, input volume:missing value, alert

data/lib/volumerb/version.rb

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
 module Volumerb
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/test/volumerb_test.rb

@@ -9,6 +9,14 @@ class VolumerbTest < Minitest::Test
     assert_match(/on|off/, volume[:state])
   end
 
+  def test_state
+    assert_match(/on|off/, Volumerb.state)
+  end
+
+  def test_value
+    assert_includes 0..100, Volumerb.value
+  end
+
   def test_up
     previous = Volumerb.vol[:value]
     assert_operator(previous, :<, Volumerb.up[:value])
@@ -29,4 +37,14 @@ class VolumerbTest < Minitest::Test
     # Restore volume
     Volumerb.mute
   end
+
+  def test_value
+    volume = Volumerb.value
+    assert_includes 0..100, volume
+    Volumerb.value = 50
+    assert_equal Volumerb.value, 50
+    Volumerb.value = 80
+    assert_equal Volumerb.value, 80
+    Volumerb.value = volume
+  end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: volumerb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-28 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
 description: Gem to manage the computer's volume
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -80,12 +80,12 @@ 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: []
@@ -96,4 +96,3 @@ specification_version: 4
 summary: Gem to manage the volume on GNU/Linux and Mac OS X operating systems
 test_files:
 - test/volumerb_test.rb
-has_rdoc: