odata-model 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe33f5051420883663adf80b9d1a59b13eafec5d
-  data.tar.gz: 126f1440868c5fd7daf861b1b15719934599756f
+  metadata.gz: c9af1e9a92b9ecf511d9da7347473c779824b9b8
+  data.tar.gz: 6172738728c6b5ed9349611bb700c5b578c3d383
 SHA512:
-  metadata.gz: 939c3fbb81c39e03a56b412383fd9822c486aa39f0439b7efeb1b97bf8f161f34ee2c242dbbef4fa50ad0016c54b85f69f9b31e6a50d2fa19bd31e2acd727a79
-  data.tar.gz: 5a88c0a36091e278714ca0026c164f1773f11f423ea0add97571766969063201bd1d19bd270ddeb78a3597a28d8e615e641c2cec106352eba358a3c089ee3d4e
+  metadata.gz: 344ff2fb53b0bc6feb3f2a9cf7ca2936a44335cb5af249d773618967d808c1772cce02bbab53a510e90a214aa79722f9091b0710e43475c745ca4dc54b525e19
+  data.tar.gz: c286f7a764c5597b190466b20e3a457d2dab750aed01ee91e214c06621f181807b80f9a886ea80d03b2c03f89ad13c3289172a5d1c8b1e2d471f2a96979f2661

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.2.0
+
+* Added `odata_service_name` to private API methods
+* Added `for_entity` as alternative to `use_entity_set`
+
 ## 0.1.1
 
 * Added bin/odata-model

data/bin/odata-model

@@ -1,58 +1,9 @@
 #!/usr/bin/env ruby
-require 'odata/model'
 require 'slop'
-require 'erb'
-
-def validate_service_url(opts)
-  unless opts[:service_url]
-    puts 'You must supply a service_url (-s, --service_url=)'
-    exit(1)
-  end
-end
-
-def handle_auth_options(opts)
-  service_options = {}
-  if opts[:username] && opts[:password]
-    service_options[:typhoeus] = {
-        username: opts[:username],
-        password: opts[:password]
-    }
-    if opts[:auth_type]
-      auth_type = opts[:auth_type].to_sym
-      service_options[:typhoeus][:httpauth] = auth_type
-    end
-  end
-  service_options
-end
-
-class ModelTemplate
-  attr_reader :class_name, :service_name, :properties
-
-  def initialize(class_name, service_name, properties)
-    @class_name = class_name
-    @service_name = service_name
-    @properties = properties
-  end
 
-  def template
-    <<-EOS
-class <%= @class_name %>
-  include OData::Model
-
-  use_service '<%= @service_name %>'
-
-<% properties.each do |property_name, as_name| %>
-  property '<%= property_name %>'<%= as_name.nil? ? nil : ", as: :\#\{as_name\}" %>
-<% end %>
-end
-    EOS
-  end
-
-  def render
-    renderer = ERB.new(template, 0, '<>')
-    renderer.result(binding)
-  end
-end
+require 'odata/model'
+require 'odata/model/cli/model_template'
+require 'odata/model/cli/generator_configuration'
 
 opts = Slop.parse do
   banner 'Usage: odata-model <command> [options]'
@@ -69,10 +20,10 @@ opts = Slop.parse do
     on :a, :auth_type=, 'CURL authentication type (optional)', argument: :optional
 
     run do |opts, args|
-      validate_service_url(opts)
+      OData::Model::CLI::GeneratorConfiguration.validate_service_url(opts)
+      generator = OData::Model::CLI::GeneratorConfiguration.new(opts)
 
-      service = OData::Service.open(opts[:service_url], handle_auth_options(opts))
-      service.entity_sets.each do |type, name|
+      generator.service.entity_sets.each do |type, name|
         puts "#{name} <EntityType: #{type}>"
       end
 
@@ -86,23 +37,17 @@ opts = Slop.parse do
     on :p, :password=, 'password (optional)', argument: :optional
     on :a, :auth_type=, 'CURL authentication type (optional)', argument: :optional
 
-    on :sn, :service_name=, 'OData service name to use', argument: :optional
+    on :n, :service_name=, 'OData service name to use', argument: :optional
     on :m, :model_name=, 'name to give model', argument: :optional
     on :e, :entity_set=, 'EntitySet to generate model for'
 
-    run do |opts, args|
-      validate_service_url(opts)
+    on :properties=, as: Array, argument: :optional
 
-      service = OData::Service.open(opts[:service_url], handle_auth_options(opts))
-      entity_set = service[opts[:entity_set]]
-      properties = service.properties_for(entity_set.type)
-
-      class_name = opts[:model_name] || entity_set.type
-      service_name = opts[:service_name] || opts[:service_url]
-      properties = Hash[properties.collect {|k,v| [k, nil]}]
+    run do |opts, args|
+      OData::Model::CLI::GeneratorConfiguration.validate_service_url(opts)
 
-      template = ModelTemplate.new(class_name, service_name, properties)
-      puts template.render
+      generator = OData::Model::CLI::GeneratorConfiguration.new(opts)
+      puts generator.generate
 
       exit(0)
     end

data/lib/odata/model/cli/generator_configuration.rb

@@ -0,0 +1,72 @@
+module OData
+  module Model
+    # Module for classes related to command-line tools
+    module CLI
+      # Represents the configuration for the command-line tool responsible for
+      # model generation.
+      # @api private
+      class GeneratorConfiguration
+        attr_reader :service, :options
+
+        def initialize(options)
+          @options = options
+          @service = OData::Service.open(service_url, handle_auth_options)
+        end
+
+        def generate
+          template = ModelTemplate.new(class_name, service_name, properties)
+          template.render
+        end
+
+        def self.validate_service_url(opts)
+          unless opts[:service_url]
+            puts 'You must supply a service_url (-s, --service_url=)'
+            exit(1)
+          end
+        end
+
+        private
+
+        def class_name
+          options[:model_name] || entity_set.type
+        end
+
+        def properties
+          if options[:properties]
+            Hash[options[:properties].collect {|property_set| property_set.split(':')}]
+          else
+            properties = service.properties_for(entity_set.type)
+            Hash[properties.collect {|k,v| [k, nil]}]
+          end
+        end
+
+        def service_name
+          options[:service_name] || service_url
+        end
+
+        def service_url
+          options[:service_url]
+        end
+
+        def entity_set
+          service[options[:entity_set]]
+        end
+
+        def handle_auth_options
+          service_options = {}
+          if options[:username] && options[:password]
+            service_options[:typhoeus] = {
+                username: options[:username],
+                password: options[:password]
+            }
+            if options[:auth_type]
+              auth_type = options[:auth_type].to_sym
+              service_options[:typhoeus][:httpauth] = auth_type
+            end
+          end
+          service_options
+        end
+      end
+    end
+  end
+end

data/lib/odata/model/cli/model_template.rb

@@ -0,0 +1,41 @@
+require 'erb'
+
+module OData
+  module Model
+    # Module for classes related to command-line tools
+    module CLI
+      # Represents the model template used by the command-line generator.
+      # @api private
+      class ModelTemplate
+        attr_reader :class_name, :service_name, :properties
+
+        def initialize(class_name, service_name, properties, entity_name)
+          @class_name = class_name
+          @service_name = service_name
+          @properties = properties
+          @entity_name = entity_name
+        end
+
+        def template
+          <<-EOS
+class <%= @class_name %>
+  include OData::Model
+
+  use_service '<%= @service_name %>'
+  <%= @entity_name.nil? ? nil : "use_entity_set  '\#\{@entity_name\}'" %>
+
+<% properties.each do |property_name, as_name| %>
+  property '<%= property_name %>'<%= as_name.nil? ? nil : ", as: :\#\{as_name\}" %>
+<% end %>
+end
+          EOS
+        end
+
+        def render
+          renderer = ERB.new(template, 0, '<>')
+          renderer.result(binding)
+        end
+      end
+    end
+  end
+end

data/lib/odata/model/configuration.rb

@@ -59,6 +59,17 @@ module OData
           nil
         end
 
+        # Define the entity set to use for the current OData::Model. This
+        # method will look up the correct EntitySet using the Entity's type
+        # name.
+        #
+        # @param entity_name [to_s] name of EntityType used by OData Service
+        # @return [nil]
+        def for_entity(entity_name)
+          odata_config[:entity_set_name] = odata_service.entity_sets[entity_name]
+          nil
+        end
+
         # Get the OData::Service
         # @return [OData::Service]
         # @api private
@@ -66,6 +77,13 @@ module OData
           odata_config[:service]
         end
 
+        # Returns the name of the OData::Service used.
+        # @return [String]
+        # @api private
+        def odata_service_name
+          odata_config[:service].name
+        end
+
         # Get the OData::Service's namespace
         # @return [String] OData Service's namespace
         # @api private

data/lib/odata/model/version.rb

@@ -1,5 +1,5 @@
 module OData
   module Model
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/spec/example_models/odatademo_person.rb

@@ -0,0 +1,9 @@
+class Person
+  include OData::Model
+
+  use_service 'ODataDemo'
+  for_entity 'Person'
+
+  property 'ID'
+  property 'Name'
+end

data/spec/model/entity_set_identification_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe OData::Model do
+  describe 'EntitySet identification and configuration' do
+    describe 'default behavior' do
+      it { expect(Product.odata_entity_set_name).to eq('Products') }
+    end
+
+    describe 'using for_entity' do
+      it { expect(Person.odata_entity_set_name).to eq('Persons') }
+    end
+  end
+end

data/spec/model/service_integration_spec.rb

@@ -10,5 +10,8 @@ describe OData::Model do
 
     it { expect(Product).to respond_to(:odata_namespace) }
     it { expect(Product.odata_namespace).to eq('ODataDemo') }
+
+    it { expect(Product).to respond_to(:odata_service_name) }
+    it { expect(Product.odata_service_name).to eq('ODataDemo') }
   end
 end

data/spec/spec_helper.rb

@@ -20,6 +20,7 @@ OData::Service.open('http://services.odata.org/OData/OData.svc', name: 'ODataDem
 
 require 'example_models/bare_model'
 require 'example_models/odatademo_product'
+require 'example_models/odatademo_person'
 
 RSpec::Matchers.define :be_boolean do
   match do |actual|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odata-model
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - James Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,16 +157,19 @@ files:
 - lib/odata/model.rb
 - lib/odata/model/active_model.rb
 - lib/odata/model/attributes.rb
+- lib/odata/model/cli/generator_configuration.rb
+- lib/odata/model/cli/model_template.rb
 - lib/odata/model/configuration.rb
 - lib/odata/model/persistence.rb
 - lib/odata/model/query.rb
 - lib/odata/model/query_proxy.rb
-- lib/odata/model/templates/model.erb
 - lib/odata/model/version.rb
 - odata-model.gemspec
 - spec/example_models/bare_model.rb
+- spec/example_models/odatademo_person.rb
 - spec/example_models/odatademo_product.rb
 - spec/model/active_model_lint_spec.rb
+- spec/model/entity_set_identification_spec.rb
 - spec/model/property_defaults_spec.rb
 - spec/model/query_interface_spec.rb
 - spec/model/query_proxy_spec.rb
@@ -198,8 +201,10 @@ specification_version: 4
 summary: An ActiveModel mapping layer for the OData gem
 test_files:
 - spec/example_models/bare_model.rb
+- spec/example_models/odatademo_person.rb
 - spec/example_models/odatademo_product.rb
 - spec/model/active_model_lint_spec.rb
+- spec/model/entity_set_identification_spec.rb
 - spec/model/property_defaults_spec.rb
 - spec/model/query_interface_spec.rb
 - spec/model/query_proxy_spec.rb