images_gallery 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67e420173590772158f6bab51506ccd9a836fe5c
-  data.tar.gz: d53ff9a4c056c12d17d31396b8325841ad16111e
+  metadata.gz: 9c7660b3a472fe00fb56538c5c8fc8c7f6773e02
+  data.tar.gz: 861279385d115536a7d833e6f539da39c14dbc07
 SHA512:
-  metadata.gz: 74de38ecf7c3ab952260a7403218354f05eccb271310f77b05872a83b1aa89555c91a6092f3b99bbaf2c6e90dd19ef6f0f2aa459773ea968fba535f3f607175e
-  data.tar.gz: 01e3e36847c68a09f17f8892c793898788b28087f0e2933e2ac1ec41d3aa66dd17875b5166bff707c6df2993633e56e56c30c339479821e6cfcda42579995480
+  metadata.gz: c57e8b3352d328f3226d77bc597aea7327c7fcf36a9bca5aed750710a422fd02c9f3280dc625f84059a9812e19e1f2395b6abd4f422418c7cb9a23ea1503608e
+  data.tar.gz: 2316bca9500ad182e6a03079c7bd2f46b4472cafd67142dac52b594b4b0429ca7c3df3825548f7dce1bcb24a903ae5d19b661f67ab71073d704514f9db8adccb

data/README.md

@@ -59,7 +59,7 @@ The `ImageGallery::Source` relies on the **LibXML** SAX parser to extract the im
 About
 -----
 
-This kata aims at writing a command-line tool to process **large** XML files which contain images metadata. Part of that metadata is relevant, and the images gallery should allow to preview a collection of thumbnails classified by camera **make** and **model**.
+This kata aims at writing a command-line tool to process **large** XML files which contain images metadata. Part of that metadata is relevant, and the images gallery should allow to preview a collection of thumbnails classified by camera **make**, **model** and **ISO speed ratings**.
 
 Because the images collections can be really large, [care has been taken][parser] to avoid loading the XML document in memory while parsing it.
 
@@ -67,7 +67,7 @@ Because the images collections can be really large, [care has been taken][parser
 
 Yet huges collections to review do also mean you probably don't want to review them without involving your team. That's to say the images gallery deployment is a key aspect of the task at hand, and keeping the files tree as simple as possible is a way to make the deployments as straightforward as possible. No external CSS, nor font, nor javascipts then.
 
-The views/templates pattern makes the design extensible, this galleries generator is no <abbr title="Content Management System">CMS</abbr> however! Priority has been given to simplify as much as possible the rendering engine task. Plain ERb should keep the HTML generation fast, while a basic partials system ensures that adding front-end features remains [a _pomodoro_-sized task][pomodoro].
+The views/templates pattern makes the design extensible, this galleries generator is no <abbr title="Content Management System">CMS</abbr> however! Priority has been given to simplify as much as possible the rendering engine task. Plain ERb should keep the HTML generation fast, while a basic partials system ensures that adding a few front-end features remains [a _pomodoro_-sized task][pomodoro]. (If more features would to be added, however, the views mechanics and the templates management should be refined - see the naviagtion links generation for example.)
 
   [pomodoro]: https://github.com/gonzalo-bulnes/kata-images_gallery_generator/commit/a90590e63f65d0b166c93e709a17a267c9ec119f
 

data/Rakefile

@@ -1,3 +1,4 @@
+require 'html/proofer'
 require 'rainbow'
 require 'rspec/core/rake_task'
 
@@ -21,4 +22,12 @@ rescue LoadError
   end
 end
 
-task default: [:spec, :inch]
+namespace :validate do
+  desc 'Verify HTML files are valid.'
+  task :html do
+    system 'images_gallery generate spec/fixtures/works.xml spec/tmp > /dev/null'
+    HTML::Proofer.new('spec/tmp', disable_external: true, check_html: true).run
+  end
+end
+
+task default: [:spec, 'validate:html', :inch]

data/lib/images_gallery/generator.rb

@@ -4,6 +4,7 @@ require 'images_gallery/models/source'
 require 'images_gallery/views/index'
 require 'images_gallery/views/make'
 require 'images_gallery/views/model'
+require 'images_gallery/views/iso'
 
 module ImagesGallery
   class Generator
@@ -44,6 +45,15 @@ module ImagesGallery
                 images_by_model << image
                 view = Views::Model.new(images_by_model)
                 files[view.file_identifier(image.make, image.model)] = view.render
+
+                images_by_model.iso_values.each do |iso_value|
+                  images_by_iso_value = Models::Collection.new
+                  images_by_model.select{ |image| image.iso == iso_value }.each do |image|
+                    images_by_iso_value << image
+                    view = Views::ISO.new(images_by_iso_value)
+                    files[view.file_identifier(image.make, image.model, image.iso)] = view.render
+                  end
+                end
               end
             end
           end
@@ -56,12 +66,17 @@ module ImagesGallery
           dir_path = "#{target}/#{name}".gsub('//', '/')
           file_path = dir_path + '.html'
           @index_path = file_path if name == 'index'
-          FileUtils.mkdir_p(dir_path) unless File.exists?(dir_path) || (name == 'index')
+          FileUtils.mkdir_p(parent(dir_path)) unless File.exists?(dir_path) || (name == 'index')
           File.open(file_path, 'w') do |file|
             file.write content
           end
         end
         @index_path
       end
+
+      def parent(dir_path)
+        return dir_path.match('(.*)\/.*$').captures.first unless dir_path.match('(.*)\/.*$').nil?
+        '.'
+      end
   end
 end

data/lib/images_gallery/models/collection.rb

@@ -12,6 +12,10 @@ module ImagesGallery
         map { |image| image.model }.uniq.sort
       end
 
+      def iso_values
+        map { |image| image.iso }.uniq.sort
+      end
+
     end
   end
 end

data/lib/images_gallery/models/image.rb

@@ -2,7 +2,15 @@ module ImagesGallery
   module Models
     class Image
 
-      attr_accessor :id, :src, :make, :model
+      attr_accessor :id, :iso, :make, :model, :src
+
+      def description
+        "Image #{@id}"
+      end
+
+      def iso
+        @iso || 'speed ratings unknown'
+      end
 
       def make
         @make || 'Unknown Make'
@@ -12,10 +20,6 @@ module ImagesGallery
         @model || 'Unknown Model'
       end
 
-      def description
-        "Image #{@id}"
-      end
-
     end
   end
 end

data/lib/images_gallery/models/source.rb

@@ -66,6 +66,10 @@ module ImagesGallery
           @current_image.id = @current_id
         end
 
+        if element == 'iso_speed_ratings'
+          @current_image.iso = @current_iso
+        end
+
         if element == 'make'
           @current_image.make = @current_make
         end
@@ -86,6 +90,10 @@ module ImagesGallery
           @current_id = char
         end
 
+        if @current_element == 'iso_speed_ratings'
+          @current_iso = char
+        end
+
         if @current_element == 'make'
           @current_make = char
         end

data/lib/images_gallery/templates/_thumbnails.html.erb

@@ -2,10 +2,11 @@
   <% images.each do |image| %>
     <div class="grid-item">
       <img alt="<%= image.description %>" src="<%= image.src %>"/>
-      <% unless depth == 1 %>
-        <a class="grid-item-details" href="<%= link_to(depth, image.make, image.model) %>" title="Browse all the <%= image.model %> images.">
+      <% unless depth > 1 %>
+        <a class="grid-item-details" href="<%= link_to(depth, image.make, image.model, image.iso) %>" title="Browse all the <%= image.model %> @ ISO <%= image.iso %> images.">
           <div><%= image.make %></div>
           <div><%= image.model %></div>
+          <div><small>ISO <%= image.iso %></small></div>
         </a>
       <% end %>
     </div>

data/lib/images_gallery/templates/layout.html.erb

@@ -35,7 +35,7 @@
         color: #333;
         font-size: .8rem;
         font-variant: small-caps;
-        height: 3rem;
+        height: 4rem;
         left: 0;
         line-height: 1.2rem;
         opacity: 0;

data/lib/images_gallery/version.rb

@@ -1,3 +1,3 @@
 module ImagesGallery
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/images_gallery/views/base.rb

@@ -41,15 +41,17 @@ module ImagesGallery
         ERB.new(File.new(template).read).result(binding)
       end
 
-      def link_to(depth, make, model=nil)
-        ('../' * depth) + file_identifier(make, model) + '.html'
+      def link_to(depth, make, model=nil, iso_value=nil)
+        ('../' * depth) + file_identifier(make, model, iso_value) + '.html'
       end
 
-      def file_identifier(make, model=nil)
+      def file_identifier(make, model=nil, iso_value=nil)
         if model.nil?
           "#{make.to_filename}"
-        else
+        elsif iso_value.nil?
           "#{make.to_filename}/#{model.to_filename}"
+        else
+          "#{make.to_filename}/#{model.to_filename}/#{iso_value.to_filename}"
         end
       end
     end

data/lib/images_gallery/views/iso.rb

@@ -0,0 +1,30 @@
+require 'erb'
+
+require 'images_gallery/views/base'
+
+module ImagesGallery
+  module Views
+    class ISO < Base
+
+      attr_reader :depth, :links, :iso, :make, :model, :sample_images, :title
+      private :depth, :links, :iso, :make, :model, :sample_images, :title
+
+      def initialize(images)
+        super()
+
+        @depth = 2
+        @make = images.first.make
+        @model = images.first.model
+        @iso = images.first.iso
+        @links = [{ name: "Browse all the images", href: link_to(depth, 'index') }]
+        @links << { name: "Browse all the #{model} images", href: link_to(depth, make, model) }
+        @sample_images = images
+        @title = "Images by (#{make}) #{model} @ ISO #{iso}"
+      end
+
+      def template
+        File.expand_path('../../templates/layout.html.erb', __FILE__)
+      end
+    end
+  end
+end

data/lib/images_gallery/views/model.rb

@@ -17,6 +17,7 @@ module ImagesGallery
         @model = images.first.model
         @links = [{ name: "Browse all the images", href: link_to(depth, 'index') }]
         @links << { name: "Browse all the #{make} images", href: link_to(depth, make) }
+        @links += images.iso_values.map{ |iso_value| { name: "ISO #{iso_value}", href: link_to(depth, make, model, iso_value) } }
         @sample_images = images
         @title = "Images by (#{make}) #{model}"
       end

data/spec/features/iso_pages/canon_eos_20d_iso_100_page_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'The Canon EOS 20D @ ISO 100 page', type: :feature do
+
+  let!(:generator) { ImagesGallery::Generator.new }
+
+  before(:each) do
+    generator.run('spec/fixtures/works.xml', 'spec/tmp/')
+    visit '/canon/canon_eos_20d/100.html'
+  end
+
+  it_behaves_like('an images gallery', 1, header_selector, navigation_selector, title_selector)
+  it_behaves_like('an ISO page', 'canon', 'canon_eos_20d', navigation_selector)
+end

data/spec/features/iso_pages/lux_d_3_iso_100_page_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'The LUX-D 3 @ ISO 100 page', type: :feature do
+
+  let!(:generator) { ImagesGallery::Generator.new }
+
+  before(:each) do
+    generator.run('spec/fixtures/works.xml', 'spec/tmp/')
+    visit '/leica/d_lux_3/100.html'
+  end
+
+  it_behaves_like('an images gallery', 3, header_selector, navigation_selector, title_selector)
+  it_behaves_like('an ISO page', 'leica', 'd_lux_3', navigation_selector)
+end

data/spec/features/iso_pages/lux_d_3_iso_200_page_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'The LUX-D 3 @ ISO 200 page', type: :feature do
+
+  let!(:generator) { ImagesGallery::Generator.new }
+
+  before(:each) do
+    generator.run('spec/fixtures/works.xml', 'spec/tmp/')
+    visit '/leica/d_lux_3/200.html'
+  end
+
+  it_behaves_like('an images gallery', 1, header_selector, navigation_selector, title_selector)
+  it_behaves_like('an ISO page', 'leica', 'd_lux_3', navigation_selector)
+end

data/spec/features/models_pages/canon_eos_20d_page_spec.rb

@@ -11,4 +11,11 @@ describe 'The Canon EOS 20D model page', type: :feature do
 
   it_behaves_like('an images gallery', 1, header_selector, navigation_selector, title_selector)
   it_behaves_like('a model page', 'canon', navigation_selector)
+
+  describe 'navigation' do
+
+    it 'contains a link to the ISO 100 page' do
+      expect(page).to have_selector "#{navigation_selector} a[href='../canon/canon_eos_20d/100.html']"
+    end
+  end
 end

data/spec/features/models_pages/lux_d_3_page_spec.rb

@@ -11,4 +11,15 @@ describe 'The LUX-D 3 model page', type: :feature do
 
   it_behaves_like('an images gallery', 5, header_selector, navigation_selector, title_selector)
   it_behaves_like('a model page', 'leica', navigation_selector)
+
+  describe 'navigation' do
+
+    it 'contains a link to the ISO 200 page' do
+      expect(page).to have_selector "#{navigation_selector} a[href='../leica/d_lux_3/200.html']"
+    end
+
+    it 'contains a link to the ISO 100 page' do
+      expect(page).to have_selector "#{navigation_selector} a[href='../leica/d_lux_3/100.html']"
+    end
+  end
 end

data/spec/lib/images_gallery/models/collection_spec.rb

@@ -7,6 +7,7 @@ describe 'Models::Collection' do
 
   it_behaves_like 'a collection'
 
+  it { expect(collection).to respond_to :iso_values }
   it { expect(collection).to respond_to :makes }
   it { expect(collection).to respond_to :models }
 

data/spec/lib/images_gallery/models/source_spec.rb

@@ -25,12 +25,17 @@ describe 'Models::Source' do
           source.parse
           source.images.each do |image|
 
-            # There is some duplication here that I couldn't remove.
+            # There is some duplication here that I couldn't remove because
+            # the shared specs do not allow to inject the object under test.
+            #
+            # I did copy the examples from the image interface spec.
             # See spec/support/spec_for_image_interface.
-
+            #
+            # The following examples mean in fact:
             #it_behaves_like 'an image'
 
             expect(image).to respond_to :description
+            expect(image).to respond_to :iso
             expect(image).to respond_to :make
             expect(image).to respond_to :model
             expect(image).to respond_to :src

data/spec/lib/images_gallery/views/iso_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+module ImagesGallery
+describe 'Views::ISO' do
+
+  let(:data) { images_collection }
+  let(:view) { Views::ISO.new(data) }
+
+  it_behaves_like 'a view'
+
+end
+end

data/spec/support/spec_for_image_interface.rb

@@ -15,4 +15,8 @@ RSpec.shared_examples 'an image' do
   it 'responds to :src' do
     expect(image).to respond_to :src
   end
+
+  it 'responds to :iso' do
+    expect(image).to respond_to :iso
+  end
 end

data/spec/support/spec_for_iso_page.rb

@@ -0,0 +1,15 @@
+RSpec.shared_examples 'an ISO page' do |make, model, navigation_selector|
+
+  describe 'navigation' do
+
+    it 'contains a link to the index page' do
+      expect(page).to have_selector "#{navigation_selector} a[href='../../index.html']"
+    end
+
+    it 'contains a link to the model page' do
+      expect(page).to have_selector "#{navigation_selector} a[href='../../#{make}/#{model}.html']"
+    end
+
+    it 'contains a link to the make page'
+  end
+end

data/spec/support/spec_for_view_interface.rb

@@ -0,0 +1,49 @@
+RSpec.shared_examples 'a view' do
+
+  it 'responds to :link_to' do
+    expect(view).to respond_to :link_to
+  end
+
+  it 'responds to :render' do
+    expect(view).to respond_to :render
+  end
+
+  it 'responds to :template' do
+    expect(view).to respond_to :template
+  end
+
+  it 'defines :template' do
+    expect { view.template }.not_to raise_error
+  end
+
+  context 'when built with no data' do
+
+    it 'exits gracefully (?)'
+  end
+
+  describe '#link_to' do
+
+    let(:depth) { 1 }
+
+    context 'when provided a depth and a make' do
+
+      it 'generates a make page URL' do
+        expect(view.link_to(depth, 'make')).to eq '../make.html'
+      end
+    end
+
+    context 'when provided a depth, a make and a model' do
+
+      it 'generates a model page URL' do
+        expect(view.link_to(depth, 'make', 'model')).to eq '../make/model.html'
+      end
+    end
+
+    context 'when provided a depth, a make, a model, and an ISO value' do
+
+      it 'generates an ISO page' do
+        expect(view.link_to(depth, 'make', 'model', 'iso_value')).to eq '../make/model/iso_value.html'
+      end
+    end
+  end
+end

data/spec/tmp/canon.html

@@ -35,7 +35,7 @@
         color: #333;
         font-size: .8rem;
         font-variant: small-caps;
-        height: 3rem;
+        height: 4rem;
         left: 0;
         line-height: 1.2rem;
         opacity: 0;
@@ -71,9 +71,10 @@
     <div class="grid-item">
       <img alt="Image 2041" src="http://ih1.redbubble.net/work.2041.1.flat,135x135,075,f.jpg"/>
       
-        <a class="grid-item-details" href="canon/canon_eos_20d.html" title="Browse all the Canon EOS 20D images.">
+        <a class="grid-item-details" href="canon/canon_eos_20d/100.html" title="Browse all the Canon EOS 20D @ ISO 100 images.">
           <div>Canon</div>
           <div>Canon EOS 20D</div>
+          <div><small>ISO 100</small></div>
         </a>
       
     </div>
@@ -81,9 +82,10 @@
     <div class="grid-item">
       <img alt="Image 777577" src="http://ih1.redbubble.net/work.777577.1.flat,135x135,075,f.jpg"/>
       
-        <a class="grid-item-details" href="canon/canon_eos_400d_digital.html" title="Browse all the Canon EOS 400D DIGITAL images.">
+        <a class="grid-item-details" href="canon/canon_eos_400d_digital/200.html" title="Browse all the Canon EOS 400D DIGITAL @ ISO 200 images.">
           <div>Canon</div>
           <div>Canon EOS 400D DIGITAL</div>
+          <div><small>ISO 200</small></div>
         </a>
       
     </div>