songbooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d039be80aa91be731b93c15a510600e11e5dcb19
+  data.tar.gz: b22174caf5f19f92cb21f6cdc5731659c920e4b0
+SHA512:
+  metadata.gz: 8b2144caaa1ca0acc9d29f63d6e27f556053a922a13a4ad824d684c9596bd23d68ac99335593fb28e98aeffdeeb7587a1414229be0be4e1f9393a87c3e19de13
+  data.tar.gz: 649206f5dd910096907c2f5c31805f4ca4179754b38c5a5fc5fffc54e93ce91f45559db12287547becca6fdaa2d44ae161489aaa1c2b2b357ee52bc3d2ab262a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history
+
+/.sass-cache
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.1
+before_install: gem install bundler -v 1.12.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in songbooks.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,29 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+coffeescript_options = {
+  input: 'app/assets/javascripts',
+  output: 'public/javascripts',
+  patterns: [%r{^app/assets/javascripts/(.+\.(?:coffee|coffee\.md|litcoffee))$}]
+}
+
+guard 'coffeescript', coffeescript_options do
+  coffeescript_options[:patterns].each { |pattern| watch(pattern) }
+end
+
+guard 'sass', :input => 'app/assets/stylesheets', :output => 'public/stylesheets'
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stefan Exner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stefan Exner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Songbooks
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/songbooks`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'songbooks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install songbooks
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/songbooks.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/application.coffee

@@ -0,0 +1,4 @@
+window.app = angular.module 'songbooks', ['ngRoute', 'LocalStorageModule']
+
+app.config (localStorageServiceProvider) ->
+  localStorageServiceProvider.setPrefix('songbooks')

data/app/assets/javascripts/components/filters/convertWhitespace.filter.coffee

@@ -0,0 +1,3 @@
+app.filter 'convertWhitespace', () ->
+  (text) ->
+    text.replace /[ ]/g, '\u00a0'

data/app/assets/javascripts/components/song_component/chord.directive.coffee

@@ -0,0 +1,9 @@
+app.directive 'chord', () ->
+  {
+    restrict: 'E',
+    template: '{{ component.name }}'
+    link: (scope, element) ->
+      $(element).attr('data-name', scope.component.name)
+      $(element).attr('data-transposed-by', scope.component.transposed_by)
+  }
+

data/app/assets/javascripts/components/song_component/literal.directive.coffee

@@ -0,0 +1,6 @@
+app.directive 'literal', () ->
+  {
+    restrict: 'E',
+    template: '{{ component.content | convertWhitespace }}'
+  }
+

data/app/assets/javascripts/components/song_component/song_component.directive.coffee

@@ -0,0 +1,6 @@
+app.directive 'songComponent', () ->
+  {
+    restrict: 'E',
+    templateUrl: 'static/songs/component'
+  }
+

data/app/assets/javascripts/components/songbook/songbook.controller.coffee

@@ -0,0 +1,29 @@
+app.controller 'SongbookController', ['$http', 'songService', ($http, songService) ->
+  @filterQuery = ''
+
+  @songs = () ->
+    songService.selectedSongs
+
+  @title = () ->
+    songService.songbookTitle
+
+  @addSong = (song) ->
+    songService.addSongToBook(song)
+
+  @removeSong = (song) ->
+    songService.removeSongFromBook(song)
+
+  @clear = () ->
+    songService.clearSongbook()
+
+  @sendToServer = () ->
+    $http.post '/songbook',
+      'songs': @songs().map (s) ->
+        s.identifier
+    .success ->
+      window.location.href = '/songbook.pdf'
+
+  @
+]
+
+

data/app/assets/javascripts/components/songs/song.controller.coffee

@@ -0,0 +1,10 @@
+app.controller 'SongController', ['$routeParams', 'songService', ($routeParams, songService) ->
+  songService.loadSong($routeParams.songIdentifier)
+
+  @song = () ->
+    songService.activeSong
+
+  @
+]
+
+

data/app/assets/javascripts/components/songs/song.directive.coffee

@@ -0,0 +1,7 @@
+app.directive 'song', () ->
+  {
+    restrict: 'E',
+    templateUrl: 'static/songs/song'
+  }
+
+

data/app/assets/javascripts/components/songs/song.service.coffee

@@ -0,0 +1,98 @@
+app.service 'songService', ['$http', 'localStorageService', ($http, localStorageService) ->
+  @activeSong = null
+  @songs = []
+  @selectedSongs = []
+  @songbookTitle = 'Songbook'
+
+  #
+  # Adds the given song to the current songbook collection
+  # This is only done in the browser and won't be submitted to the server
+  # until a PDF is requested
+  #
+  @addSongToBook = (song) ->
+    @selectedSongs.push(song) unless @songInCollection(song, @selectedSongs)
+    @persistSongbook()
+
+  #
+  # Adds all currently available songs to the songbook
+  #
+  @addAllToBook = () ->
+    angular.forEach @songs, (song) =>
+      @selectedSongs.push(song) unless @songInCollection(song, @selectedSongs)
+    @persistSongbook()
+
+  #
+  # Removes the given song from the current songbook collection
+  # This is only done in the browser and won't be submitted to the server
+  # until a PDF is requested
+  #
+  @removeSongFromBook = (song) ->
+    if (idx = @songPositionInCollection(song, @selectedSongs)) > -1
+      @selectedSongs.splice(idx, 1)
+      @persistSongbook()
+
+  @setActiveSong = (identifier) ->
+    for song in @songs
+      if song.identifier == identifier
+        @activeSong.active = false if @activeSong
+        @activeSong = song
+        song.active = true
+        break
+
+  @loadSong = (identifier) ->
+    $http.get("/songs/#{identifier}.json").success (response) =>
+      @setActiveSong(identifier)
+      @activeSong.sections = response.data.sections
+
+  @loadSongs = () ->
+    $http.get('/songs.json').success (response) =>
+      @songs = response.data
+      @restoreSongbook()
+
+  #
+  # @return [Boolean] +true+ if the song is part of the given collection
+  #
+  @songInCollection = (song, collection) ->
+    @songPositionInCollection(song, collection) > -1
+
+  #
+  # @return [Integer] the array index of the given song within the given collection
+  #   or -1 if the song is not a part of it.
+  #
+  @songPositionInCollection = (song, collection) ->
+    result = -1
+    angular.forEach collection, (s, idx) ->
+      result = idx if s.identifier == song.identifier
+    result
+
+  #
+  # Loads a previously created songbook from the browser's local storage
+  #
+  @restoreSongbook = () ->
+    if (storedBook = localStorageService.get('songbook'))
+      @songbookTitle = storedBook.title
+      angular.forEach storedBook.songs, (song) =>
+        @selectedSongs.push(song) if @songInCollection(song, @songs)
+
+  #
+  # Saves the current songbook in the browser's local storage
+  #
+  @persistSongbook = () ->
+    localStorageService.set 'songbook',
+      'songs': @selectedSongs
+      'title': @songbookTitle
+
+  #
+  # Clears the local songbook
+  # This is only done in the browser and won't be submitted to the server
+  # until a PDF is requested
+  #
+  @clearSongbook = () ->
+    @selectedSongs = []
+    @songbookTitle = 'Songbook'
+    localStorageService.remove('songbook')
+
+  @
+]
+
+

data/app/assets/javascripts/components/songs/songs.controller.coffee

@@ -0,0 +1,21 @@
+app.controller 'SongsController', ['$http', 'songService', '$location', ($http, songService, $location) ->
+  songService.loadSongs()
+
+  @filterQuery = ''
+
+  @songs = () ->
+    songService.songs
+
+  @setActive = (song) ->
+    $location.path("/songs/#{song.identifier}")
+
+  @activeSong = () ->
+    songService.activeSong
+
+  @addAllToBook = () ->
+    songService.addAllToBook()
+
+  @
+]
+
+

data/app/assets/javascripts/routes.coffee

@@ -0,0 +1,11 @@
+app.config ['$routeProvider', ($routeProvider) ->
+  $routeProvider
+  .when '/songs/:songIdentifier',
+    title: 'Song',
+    templateUrl: 'static/songs/show'
+    controller: 'SongController as songCtrl'
+  .when '/',
+    template: 'Choose a song on the left'
+  .otherwise
+      redirectTo: '/'
+]

data/app/assets/stylesheets/application.scss

@@ -0,0 +1,34 @@
+body {
+  padding: 10px;
+}
+
+#file-list {
+  max-height: 500px;
+  overflow-x: auto;
+}
+
+#songs {
+  max-height: 700px;
+  overflow: scroll;
+}
+
+song-component {
+  font-family: "Courier New", Courier, monospace;
+  display: inline-block;
+}
+
+chord {
+  color: darkred;
+}
+
+a {
+  &[ng-click] {
+    cursor: pointer;
+  }
+}
+
+@media only print {
+  .panel {
+    border: none;
+  }
+}