icemaker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9704bb75c9c106080a4816897bffb3c9edf9953
-  data.tar.gz: 38727cf25913f22bb78e87b87ab3f10ad5549e38
+  metadata.gz: 2c4d35a2e92669d91e168cc3b143c76c66062354
+  data.tar.gz: 8dd4fa5b0b1414d7c2bea0d92ade18e80202f2aa
 SHA512:
-  metadata.gz: c44e11e086d03248c277dc4cd5fcec8a0bda44c4afd2b1807c742f2ed131cfe85c5d9a588b52b0362e5b3d830e3b9bb04e763773230e4306b1ad17d595fdcc10
-  data.tar.gz: 556f996c0971dbe5df781db0c90eb2ab548c58600f3e50bef48d5744be366ccbfad0416f4de99ebe7d30175f5c438700195e0be43ea4f5283f5e8164db9d4bce
+  metadata.gz: 29659ba44156e7887259f597177f2c177acdbeae965a63211ef9252898775a6b7a2c4cd04b5714ec9301d6e31d2755e4e719edf921cfa1785852e102d7fbe1e3
+  data.tar.gz: ec89388cec9787d6b89bcac3f034c190d9ba0a50f9cf42b951e4baa2912172bb774eb199f9814e3e7ce527fa56e79f8d37e6be97a841ba59860f5187edc304ab

data/README.md

@@ -1,7 +1,9 @@
+![Gem Version](https://badge.fury.io/rb/icemaker.svg)
 # Icemaker
 
-  Create playlists by applying customized search filters to a set of audio files.
+`icemaker` is a small cli tool, written in Ruby, that applies search filters to the audio metadata of a set of files and writes any matches out to disk.  It was created to write playlists for Ices/Icecast; hence the name.
 
+Access to the metadata is provided via [taglib-ruby](https://rubygems.org/gems/taglib-ruby).
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,14 +22,91 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+run `icemaker` in a directory containing an `Icefile`.
 
-## Development
+```ruby
+# An example Icefile
+
+Icemaker::Playlist.make do |with|
+
+  # .sources, an array containing paths to the locations of the audio files we want to search
+  with.sources = ['/path/to/some/music']
+
+  # .is_recursive, if true, do a fully recursive search through the sources
+  with.is_recursive = true
+
+  # .verbose, if true, verbalize some status info during run, if false, remain silent
+  with.verbose = true
+
+  # .output_to_file, the name of the output file, if a full path is
+  # given, it will need to exist before writing out to the file.
+  with.output_to_file = 'playlist.txt'
+
+  # .formatter, the format string for the output
+  # the following is the default formatter for the playlist output and,
+  # as such, it's redundant to specify it in the Icefile its presence here is merely instructional
+  # with.formatter = lambda { |track| "#{track[:file]}" }
+
+  # an example of a custom formatter; the keys for the hash are any of the searchable fields
+  #with.formatter = lambda { |track| "#{track[:file]} genre: #{track[:genre]} length: #{track[:length]}"}
+
+  # .filters, the array of search filters applied to each track, they take the basic form:
+
+  # { search_field: { search_operator: search_term}}
+
+  # searchable fields are:
+  # :title
+  # :artist
+  # :album
+  # :genre
+  # :year
+  # :length
+  # :bitrate
+  # :channels
+  # :sample_rate
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  # available search operators (and their synonyms) are:
+  # :is (eq:)
+  # :has (contains:)
+  # :gt (greater_than:)
+  # :gte (greater_than_or_equal_to:)
+  # :lt (less_than:)
+  # :lte (less_than_or_equal_to:)
+  # :regx (satisfies:)
+
+  # all searches are case insensitive, however, case sensitive searches are available using the :regx search operator
+
+  # some examples:
+
+  with.filters << { genre: { is: "ambient" }}
+  with.filters << { album: { has: "air structures" }}  
+  with.filters << { length: { gt: 200 }}
+  with.filters << { length: { lt: 800 }}
+  with.filters << { artist: { regx: /[Ff]ripp/}}
+
+  # compound search terms are given as a hash where the
+  # key represents a boolean operator (:or, :and) and the value
+  # is an array of terms to which the operator is applied.
+
+  # { search_field: { search_operator: { boolean_operator: [search_term_0, search_term_1,...] }}}
+
+  # some examples of compound search terms:
+
+  #with.filters << { artist: { has: { or: ["Aphex", "Cowboy"] }}}
+  #with.filters << { genre: { has: { and: ["Ambient", "Darkwave"] }}}
+
+  # synonyms for boolean_operators are:
+  # :intersection_of for :and
+  # :union_of for :or
+
+  #with.filters << { artist: { has: { union_of: ["Aphex", "Cowboy"] }}}
+  #with.filters << { genre: { has: { intersection_of: ["Ambient", "Darkwave"] }}}
+
+end
+```
 
-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).
+A much smaller example `Icefile` is available in the `/examples` directory.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/twocats/icemaker.
+Bug reports are welcome on GitHub at https://github.com/twocats/icemaker.

data/examples/Icefile

@@ -0,0 +1,13 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Icemaker::Playlist.make do |with|
+
+  with.sources = ['/path/to/some/music']
+  with.is_recursive = true
+  with.verbose = true
+  with.output_to_file = 'playlist.txt'
+
+  # with.filters << { album: { has: "air structures" }}
+
+end

data/lib/icemaker.rb

@@ -4,6 +4,15 @@ require 'icemaker/filter'
 require 'icemaker/query'
 require 'icemaker/icemaker'
 
+module Icemaker
+  ALLOWED_MEDIA_EXTENSIONS = ['.mp3', '.ogg', '.flac']
+  DEFAULT_PLAYLIST_FILE = 'playlist.txt'
+  DEFAULT_FORMATTER = lambda { |track| "#{track[:file]}"}
+  DEFAULT_VERBOSE_VALUE = true
+  DEFAULT_RECURSIVE_VALUE = true
+  UNKNOWN_VALUE = 'unknown'
+end
+
 class String
   def has(params)
     self.index params[:substring]

data/lib/icemaker/filter.rb

@@ -1,4 +1,4 @@
-module IceMaker
+module Icemaker
 
   class Filter
 
@@ -26,7 +26,7 @@ module IceMaker
     def satisfies
       regx
     end
-    
+
     def has
       if @value_to_test.instance_of? Hash then
 

data/lib/icemaker/icemaker.rb

@@ -1,7 +1,4 @@
-module IceMaker
-
-  VALID_MEDIA_EXTENSIONS = [".mp3", ".ogg", ".flac"]
-  UNKNOWN_VALUE = 'unknown'
+module Icemaker
 
   class Playlist
 
@@ -51,10 +48,8 @@ module IceMaker
 
       end
 
-      @@files.flatten!.map! { |file| "#{@@icefile.arbitrary_file_prefix}#{file}"}
-
-      @@files.uniq! if @@icefile.unique
-
+      @@files.flatten!
+      
     end
 
     def self.remove_non_audio_files
@@ -62,7 +57,7 @@ module IceMaker
       verbalize "#{@@files.length} total files found."
 
       @@files.reject! { |file|
-        !(VALID_MEDIA_EXTENSIONS.include? (File.extname file).downcase) || (File.directory? file )
+        !(ALLOWED_MEDIA_EXTENSIONS.include? (File.extname file).downcase) || (File.directory? file )
       }
 
       verbalize "#{@@files.length} audio files found."
@@ -116,17 +111,15 @@ module IceMaker
 
     class Icefile
 
-      attr_accessor :sources, :is_recursive, :unique, :verbose,
-      :output_to_file, :arbitrary_file_prefix, :filters, :formatter
+      attr_accessor :sources, :is_recursive, :verbose, :output_to_file, :filters, :formatter
 
       def initialize
         @sources = []
         @filters = []
-        @verbose = false
-        @is_recursive = false
-        @unique = true
-        @arbitrary_file_prefix = ''
-        @formatter = lambda { |track| "#{track[:file]}"}
+        @verbose = DEFAULT_VERBOSE_VALUE
+        @is_recursive = DEFAULT_RECURSIVE_VALUE
+        @formatter = DEFAULT_FORMATTER
+        @output_to_file = DEFAULT_PLAYLIST_FILE
       end
     end
   end

data/lib/icemaker/query.rb

@@ -1,4 +1,4 @@
-module IceMaker
+module Icemaker
 
   class Query
 

data/lib/icemaker/version.rb

@@ -1,3 +1,3 @@
 module Icemaker
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: icemaker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - twocats
@@ -80,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - bin/icemaker
+- examples/Icefile
 - icemaker.gemspec
 - lib/icemaker.rb
 - lib/icemaker/filter.rb