barr 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1325be83970f3c39bd02fb2cbdae88e2ba56fc06
-  data.tar.gz: 6f538d8834b692fa2c738429affdc4ceac7d3e77
+  metadata.gz: ecd1764d1551147046c97126a5a04b0846da9a09
+  data.tar.gz: b9dd688b430745a77329f02ad1fca93b2bb0f471
 SHA512:
-  metadata.gz: 83c7b0e7b9c402689db78859badc46f9e56af8b94e6df1450479d711ec8c5e7c8dfad064f89c9923e16a66be559ec98e5ff1b3343e71b0b5f7cff3fe2d09c606
-  data.tar.gz: 11a34a6d9d699f5b6947eb6f32c1b836e35bf1067e3c458af7d0d619c04c18f2e335c83c1971b620cc8b43360adb9ce837f1446a642991ee247bc03532fa481e
+  metadata.gz: 8424e88aa276c9971652084baecc3876f53faf5b9099c86d8270dfd053b7bc7319f968b9481b8e0d56fb4f6f3054611f4a1648c82c0ff1cecdefafe0db4045b7
+  data.tar.gz: c586af613120ab41d5b28a651bcfb8f1a56fb9aac0cb0668b50f99cc0569fea0388559c1a2f5fd2ae3499e411254a1124e03c1708440f76bae3b86d11458b2d8

data/README.md

@@ -14,6 +14,10 @@ If that doesn't work, you probably don't have Ruby installed. I'd recommend you
 
 For a simpler install, check your distro's package manager. That should be fine.
 
+To update to the latest release of Barr:
+
+    $ gem update barr
+
 ## Usage
 
 See [Examples folder](http://github.com/okaydave/barr/tree/master/examples) for more detailed usage examples.
@@ -81,7 +85,7 @@ All blocks inherit their behaviour from a base Block. This means that all blocks
 | ------ | ----- | ----------- | ------- |
 | `fgcolor` | RGB Hex string or `-` | Equivalent to lemonbar's `%{F}` format. Takes a hex string in the format of `#FFF`, `#FFFFFF`, or `#FFFFFFFF` (for transparency). | `'-'` |
 | `bgcolor` | RGB Hex string or `-` | As above. To use the configured lemonbar colors, use `'-'`. This also applies to the `fgcolor` option. | `'-'` |
-| `icon`   | String | This is prepended to each blocks' data. It can be a normal string like `'CPU:'` or a unicode string like `"\uf164"` (thumbs up in Font Awesome | `''` |
+| `icon`   | String | This is prepended to each blocks' data. It can be a normal string like `'CPU:'` or a unicode string like `"\uf164"` (thumbs up in Font Awesome) | `''` |
 | `interval` | Integer | How frequently the Block should perform its `update!` method in seconds. The block is drawn to lemonbar every second, this just affects how frequently the data can change.  | `5` |
 | `align` | Symbol | One of `:l`, `:c`, `:r` for left, centre and right alignment respectively. | `:l` |
 
@@ -146,7 +150,7 @@ seperate_block = Barr::Blocks::Whoami.new
 
 ### Block Specific Configuration
 
-#### Battery 
+#### Battery
 
 Show battery status.
 
@@ -156,6 +160,17 @@ Show battery status.
 | --- | --- | --- | --- |
 | `show_remaining` | bool | Show the remaining battery time | `true` |
 
+#### Bspwm (Experimental)
+
+**Requires Bspwm**. Shows desktops for selected monitor. and highlights focused one. Unfocused desktops are clickable. Could do with some optimization work and feedback from people that use BSP frequently, especially with multiple monitors. 
+
+`bsp = Barr::Blocks::Bspwm.new monitor: "DP-4", invert_focus_colors: true` 
+
+| Option | Value | Description | Default |
+| --- | --- | --- | --- |
+| `focus_markers` | 2 element Array | These are used to 'highlight' the active workspace. The first element is used on the left of the active workspace, the second element on the right. | `['>', '<']` |
+| `invert_focus_colors` | bool | Should the block's `fgcolor` and `bgcolor` attributes be reversed for the workspace that is currently focused. | `false` |
+| `monitor` | String | The monitor ID (e.g. from `xrandr`) that the bar should read the desktops from. | First monitor found |
 
 #### Clock
 
@@ -167,6 +182,17 @@ Shows the current date and/or time.
 | --- | --- | --- | --- |
 | `format` | strftime String | This takes a [strftime](http://ruby-doc.org/core-2.2.0/Time.html#method-i-strftime) formatted string. If you're not familiar with this syntax, you could use an [online generator](http://www.foragoodstrftime.com/).  | `'%H:%M %m %b %Y'` |
 
+
+#### Conky (Experimental)
+
+**Requires Conky**.  Show a conky `TEXT` formatted output. This is quite inefficient at the moment and if left running for prolonged periods will eat up your disk space. Otherwise works okay. Not all conky variables work well, will take a bit of trial and error.
+
+`conky = Barr::Blocks::Conky.new string: "${cpu}"`
+
+| Option | Value | Description | Default |
+| --- | --- | --- | --- | 
+| `text` | Conky 'TEXT' string | String made up of [one or more conky variables](http://conky.sourceforge.net/variables.html), as you might find in the `TEXT` section of a conkyrc | **REQUIRED** | 
+
 #### CPU
 
 Shows CPU load averaged across all cores.
@@ -235,6 +261,16 @@ There are no `Processes` block specific configurable options.
 | `buttons` | bool | As above, but for the player control buttons | `true` |
 | `title` | bool | As above, but for the track title | `true` |
 
+
+#### Separator
+
+This block is a simple string to be used as a separator between other blocks.
+
+| Option | Value | Description | Default |
+| --- | --- | --- | --- |
+| `symbol` | any string | The string to use as a separator | `&#124;`
+
+
 #### Temperature
 
 Shows the current temperature and summary of a given location ID. Clicking it will open the full report in your browser.
@@ -243,8 +279,8 @@ Shows the current temperature and summary of a given location ID. Clicking it wi
 
 | Option | Value | Description | Default |
 | --- | --- | --- | --- |
-| `location` | Yahoo Weather string | The ID [Yahoo Weather](https://weather.yahoo.com) uses for your chosen location. Search for your location then use the number that appears at the end of the URL. For example, New York is 2459115| **REQUIRED**
-| `unit` | `'C'` or `'F'` | Choose between Celcius and Fahrenheit. | `'C'`
+| `location` | Yahoo Weather string | The ID [Yahoo Weather](https://weather.yahoo.com) uses for your chosen location. Search for your location then use the number that appears at the end of the URL. For example, New York is 2459115| **REQUIRED** |
+| `unit` | `'C'` or `'F'` | Choose between Celcius and Fahrenheit. | `'C'` |
 
 
 #### Whoami
@@ -255,6 +291,8 @@ Shows the currently logged in user.
 
 There are no `Whoami` block specific configurable options.
 
+
+
 ## Create Your Own Block
 
 It's reasonably simple to add your own block to your script. Create a `class` that inherits from `Barr::Block` and add your custom `initialize` and `update!` methods. The `Barr::Manager` object will read your block's `@output` on each update.

data/examples/README.md

@@ -8,6 +8,10 @@
 
 ![barr_example.rb](http://i.imgur.com/r4dtoqm.png)
 
+## bsp.rb
+
+![bsp.rb](http://i.imgur.com/DDqCoeq.png)
+
 ## fizzbuzz.rb
 
 ![fizzbuzz.rb](http://i.imgur.com/Cy0ZdrN.png)

data/examples/bsp.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'barr'
+
+@man = Barr::Manager.new
+
+bsp = Barr::Blocks::Bspwm.new icon: "\uf108", bgcolor: '#114152', fgcolor: '#DAC1DE', align: :l, focus_markers: ['',''], invert_focus_colors: true, interval: 1
+
+bsp_df = Barr::Blocks::Bspwm.new align: :r, interval: 1
+
+@man.add bsp
+@man.add bsp_df
+
+@man.run!

data/examples/conky.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'barr'
+
+@man = Barr::Manager.new
+
+netspeed = Barr::Blocks::Conky.new text: "${downspeedf enp3s0} ${upspeedf enp3s0}", align: :l, interval: 1
+cpu = Barr::Blocks::Conky.new text: "${cpubar}", align: :c, interval: 1
+swap = Barr::Blocks::Conky.new text: "${swap}", align: :r, interval: 1
+
+@man.add netspeed
+@man.add cpu
+@man.add swap
+
+@man.run!

data/lib/barr.rb

@@ -3,7 +3,9 @@ require 'barr/manager'
 require 'barr/block'
 
 require 'barr/blocks/battery'
+require 'barr/blocks/bspwm'
 require 'barr/blocks/clock'
+require 'barr/blocks/conky'
 require 'barr/blocks/cpu'
 require 'barr/blocks/hdd'
 require 'barr/blocks/i3'
@@ -13,6 +15,7 @@ require 'barr/blocks/processes'
 require 'barr/blocks/rhythmbox'
 require 'barr/blocks/temperature'
 require 'barr/blocks/whoami'
+require 'barr/blocks/separator'
 
 module Barr
 end

data/lib/barr/block.rb

@@ -1,6 +1,7 @@
 module Barr
   class Block
-    attr_reader :align, :bgcolor, :fgcolor, :icon, :interval, :output
+    attr_reader :align, :bgcolor, :fgcolor, :icon, :interval, :output 
+    attr_accessor :manager
 
     def initialize(opts = {})
       reassign_deprecated_option opts, :fcolor, :fgcolor
@@ -32,6 +33,11 @@ module Barr
     def update!
     end
 
+    def tmp_filename
+      @tmp_filename ||= "/tmp/#{SecureRandom.uuid}-#{self.class.name.gsub(/::/, "-")}-#{SecureRandom.urlsafe_base64}"
+      return @tmp_filename
+    end
+
     # Backwards compatiblity methods.
     # can't use alias/alias_method as they don't
     # trickle down to subclasses 
@@ -40,7 +46,7 @@ module Barr
     
     def reassign_deprecated_option opts, old, new
       if opts[new].nil? && !opts[old].nil?
-        STDERR.puts "Warning: the '#{old}' option will soon be deprecated in favour of '#{new}'. \n Please update your script."
+        STDERR.puts "Warning: #{self.class.name}'s '#{old}' option will soon be deprecated in favour of '#{new}'. \n Please update your script."
         opts[new] = opts[old]
       end
     end

data/lib/barr/blocks/bspwm.rb

@@ -0,0 +1,72 @@
+require 'barr/block'
+require 'json'
+
+module Barr
+  module Blocks
+
+    class Bspwm < Block
+
+      attr_reader :monitor, :tree, :focus_markers
+      attr_accessor :invert_focus_colors
+      def initialize opts={}
+        super
+        @monitor = opts[:monitor] || first_monitor
+        @invert_focus_colors = opts[:invert_focus_colors] || false
+        @focus_markers = opts[:focus_markers] || %w(> <)
+      end
+
+      def update!
+        @tree = nil
+        op = []
+        focused = ""
+        
+        bsp_tree["monitors"].each do |monitor|
+          next if monitor["name"] != @monitor
+          focused = monitor["focusedDesktopName"]
+          monitor["desktops"].each do |desktop|
+            if desktop["name"] == focused
+              op << focused_desktop(desktop)
+            else
+              op << unfocused_desktop(desktop)
+            end
+          end
+          
+        end
+
+        @output = op.join(" ")
+      end
+
+      def bsp_tree
+        @tree ||= JSON.parse(sys_cmd)
+      end
+
+      def focused_desktop desktop
+        op = ""
+        op += invert_colors if @invert_focus_colors
+        op += @focus_markers[0] + " "
+        op += desktop["name"]
+        op += " " + @focus_markers[1] 
+        op += invert_colors if @invert_focus_colors
+
+        op
+      end
+
+      def unfocused_desktop desktop
+        op = ""
+        op += "%{A:bspc desktop -f #{desktop["name"].gsub(":","\:")}:} "
+        op += "#{desktop["name"]}"
+        op += " %{A}"
+
+        return op
+      end
+      
+      def first_monitor
+        bsp_tree["primaryMonitorName"]
+      end
+
+      def sys_cmd
+        `bspc wm -d`.chomp
+      end
+    end
+  end
+end

data/lib/barr/blocks/conky.rb

@@ -0,0 +1,54 @@
+require 'barr/block'
+
+module Barr
+  module Blocks
+
+    class Conky < Block
+      attr_reader :text
+      def initialize opts={}
+        super
+        @text = opts[:text]
+
+        write_template
+        spawn_conky
+      end
+
+      def update!
+        @output = sys_cmd
+      end
+
+      def sys_cmd
+        `tail -n1 #{@filename_output}`.chomp.gsub("#","\u2588")
+      end
+
+      def write_template
+        @conky_template = " 
+          out_to_x no 
+          out_to_console yes
+          own_window no 
+          update_interval #{@interval.to_f.to_s}
+          TEXT
+          #{@text} 
+        ".gsub(/^\s+/, '').chomp!
+
+        @filename_template = tmp_filename+"-conky"
+        @filename_output = tmp_filename+"-output"
+
+        STDERR.puts "@conky_template: "
+        STDERR.puts @conky_template
+        File.open(@filename_template, "w") { |f| f.write(@conky_template) }
+      end
+
+      def spawn_conky
+        @process = spawn("conky -c #{@filename_template} > #{@filename_output}")
+        Process.detach(@process)
+      end
+
+      def destroy!
+        `rm #{@filename_template}`
+        `rm #{@filename_output}`
+      end
+      
+    end
+  end
+end

data/lib/barr/blocks/separator.rb

@@ -0,0 +1,18 @@
+require 'barr/block'
+
+module Barr
+  module Blocks
+    class Separator < Block
+
+      def initialize(opts = {})
+        super
+        @symbol = opts[:symbol] || '|'
+      end
+
+      def update!
+        @output = @symbol
+      end
+
+    end
+  end
+end

data/lib/barr/manager.rb

@@ -1,4 +1,5 @@
 require 'barr/block'
+require 'securerandom'
 
 module Barr
   class Manager
@@ -13,6 +14,7 @@ module Barr
     end
 
     def add(block)
+      block.manager = self
       @blocks << block
     end
 
@@ -62,6 +64,10 @@ module Barr
 
       @count += 1
     end
+
+    def id
+      @id ||= SecureRandom.uuid
+    end
     
     # compatibility methods.
     # alias_method would work here, but for consistency with Block

data/lib/barr/version.rb

@@ -1,3 +1,3 @@
 module Barr
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barr
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Dave Russell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,8 @@ files:
 - examples/README.md
 - examples/all_in.rb
 - examples/barr_example.rb
+- examples/bsp.rb
+- examples/conky.rb
 - examples/fizzbuzz.rb
 - examples/i3_cpu_mem.rb
 - examples/rhythm.rb
@@ -127,7 +129,9 @@ files:
 - lib/barr.rb
 - lib/barr/block.rb
 - lib/barr/blocks/battery.rb
+- lib/barr/blocks/bspwm.rb
 - lib/barr/blocks/clock.rb
+- lib/barr/blocks/conky.rb
 - lib/barr/blocks/cpu.rb
 - lib/barr/blocks/hdd.rb
 - lib/barr/blocks/i3.rb
@@ -135,6 +139,7 @@ files:
 - lib/barr/blocks/mem.rb
 - lib/barr/blocks/processes.rb
 - lib/barr/blocks/rhythmbox.rb
+- lib/barr/blocks/separator.rb
 - lib/barr/blocks/temperature.rb
 - lib/barr/blocks/whoami.rb
 - lib/barr/manager.rb